Displays a paginated navigation to next/previous set of posts, when applicable.

Parameters

$argsarrayoptional

See get_the_posts_pagination() for available arguments.

More Arguments from get_the_posts_pagination( … $args )

Array or string of arguments for generating paginated links for archives.

• base string
  Base of the paginated url.
• format string
  Format for the pagination structure.
• total int
  The total amount of pages. Default is the value WP_Query‘s max_num_pages or 1.
• current int
  The current page number. Default is 'paged' query var or 1.
• aria_current string
  The value for the aria-current attribute. Possible values are 'page', 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'.
• show_all bool
  Whether to show all pages. Default false.
• end_size int
  How many numbers on either the start and the end list edges.
  Default 1.
• mid_size int
  How many numbers to either side of the current pages. Default 2.
• prev_next bool
  Whether to include the previous and next links in the list. Default true.
• prev_text string
  The previous page text. Default ‘« Previous’.
• next_text string
  The next page text. Default ‘Next »’.
• type string
  Controls format of the returned value. Possible values are 'plain', 'array' and 'list'. Default is 'plain'.
• add_args array
  An array of query args to add. Default false.
• add_fragment string
  A string to append to each link.
• before_page_number string
  A string to appear before the page number.
• after_page_number string
  A string to append after the page number.

Default:array()

Source

function the_posts_pagination( $args = array() ) {
	echo get_the_posts_pagination( $args );
}

View all references View on Trac View on GitHub

Changelog