paginate_links( string|array $args = '' )

使用示例

• 示例1

  使用自定义查询的例子
  当用新的 WP_Query 查询一个循环时，将 total 参数设置为 WP_Query 对象的 max_num_pages 属性。

  自定义查询示例：

  <?php
  //Protect against arbitrary paged values
  $paged = ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1;
  
  $args = array(
  	'posts_per_page' => 5,
  	'category_name' => 'gallery',
  	'paged' => $paged,
  );
  
  $the_query = new WP_Query( $args );
  ?>
  <!-- the loop etc.. -->
  

  适用于上述自定义查询的paginate_links参数示例：

  <?php
  $big = 999999999; // need an unlikely integer
  
  echo paginate_links( array(
  	'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
  	'format' => '?paged=%#%',
  	'current' => max( 1, get_query_var('paged') ),
  	'total' => $the_query->max_num_pages
  ) );
  ?>
  

• 示例2

  改善可访问性
  为编号的链接添加上下文，以确保屏幕阅读器用户了解链接的用途：

  <?php
  global $wp_query;
  
  $big = 999999999; // need an unlikely integer
  $translated = __( 'Page', 'mytextdomain' ); // Supply translatable string
  
  echo paginate_links( array(
  	'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
  	'format' => '?paged=%#%',
  	'current' => max( 1, get_query_var('paged') ),
  	'total' => $wp_query->max_num_pages,
          'before_page_number' => '<span class="screen-reader-text">'.$translated.' </span>'
  ) );
  ?>
  

• 示例3

  注意，base参数应该是完全限定的，例如https://example.com/my-post/%_%#some-id，而不仅仅是%_%#some-id。

  如果base参数不包含绝对URL，那么当您在第二个页面上时，到第一个页面的链接将不起作用；相反，它将链接到当前页面。这是因为“Previous”链接设置为base参数，删除了%_%部分，没有添加额外的?paged=%#%部分。然后，浏览器将其解释为当前页面，因此“上一个”链接指向当前页面。

• 示例4

  您可能会注意到，paginate_links总是返回HTML，即使您将type设置为array，这使得您想要完全定制分页的HTML结构有点困难。我编写了一个小函数，它将返回一个对象数组，而不是HTML，这可能会使这变得更容易。

  function wpdocs_get_paginated_links( $query ) {
      // When we're on page 1, 'paged' is 0, but we're counting from 1,
      // so we're using max() to get 1 instead of 0
      $currentPage = max( 1, get_query_var( 'paged', 1 ) );
  
      // This creates an array with all available page numbers, if there
      // is only *one* page, max_num_pages will return 0, so here we also
      // use the max() function to make sure we'll always get 1
      $pages = range( 1, max( 1, $query->max_num_pages ) );
  
      // Now, map over $pages and return the page number, the url to that
      // page and a boolean indicating whether that number is the current page
      return array_map( function( $page ) use ( $currentPage ) {
          return ( object ) array(
              "isCurrent" => $page == $currentPage,
              "page" => $page,
              "url" => get_pagenum_link( $page )
          );
      }, $pages );
  }

  然后这样使用它（假设$query是自定义查询的名称）：

  <ul>
      <?php foreach( wpdocs_get_paginated_links( $query ) as $link ) : ?>
      <li>
          <?php if ( $link->isCurrent ): ?>
              <strong><?php _e( $link->page ) ?></strong>
          <?php else : ?>
              <a href="<?php esc_attr_e( $link->url ) ?>">
                  <?php _e( $link->page ) ?>
              </a>
          <?php endif; ?>
      </li>
      <?php endforeach; ?>
  </ul>

• 示例5

  基本示例
  要将分页添加到搜索结果和存档中，可以使用以下示例：

  <?php
  global $wp_query;
  
  $big = 999999999; // need an unlikely integer
  
  echo paginate_links( array(
  	'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
  	'format' => '?paged=%#%',
  	'current' => max( 1, get_query_var('paged') ),
  	'total' => $wp_query->max_num_pages
  ) );
  ?>
  

• 示例6

  // first create a function 
  function pagainate_link_function(){
  	global $wp_query;
  	echo paginate_links(array(
  		'current'=>max(1,get_query_var('paged')),
  		'total'=>$wp_query->max_num_pages,
  		'type'=>'list', //default it will return anchor
  	));
  }
  
  // Now call this function in your desired place
  

• 示例7

  <?php
  global $wp_query;
  
  $big = 999999999; // need an unlikely integer
  
  echo paginate_links( array(
      'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
      'format'  => '?paged=%#%',
      'current' => max( 1, get_query_var('paged') ),
      'total'   => $wp_query->max_num_pages
  ) );
  ?>
  

  根据WPC正确对齐数组项。