On this page
get_posts_nav_link( string|array $args = array() ): string
Retrieves the post pages link navigation for previous and next pages.
Parameters
$argsstring|array Optional-
Arguments to build the post pages link navigation.
sepstringSeparator character. Default'—'.prelabelstringLink text to display for the previous page link.
Default '« Previous Page'.nxtlabelstringLink text to display for the next page link.
Default 'Next Page »'.
Default:
array()
Return
string The posts link navigation.
Source
File: wp-includes/link-template.php. View all references
function get_posts_nav_link( $args = array() ) {
global $wp_query;
$return = '';
if ( ! is_singular() ) {
$defaults = array(
'sep' => ' — ',
'prelabel' => __( '« Previous Page' ),
'nxtlabel' => __( 'Next Page »' ),
);
$args = wp_parse_args( $args, $defaults );
$max_num_pages = $wp_query->max_num_pages;
$paged = get_query_var( 'paged' );
// Only have sep if there's both prev and next results.
if ( $paged < 2 || $paged >= $max_num_pages ) {
$args['sep'] = '';
}
if ( $max_num_pages > 1 ) {
$return = get_previous_posts_link( $args['prelabel'] );
$return .= preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $args['sep'] );
$return .= get_next_posts_link( $args['nxtlabel'] );
}
}
return $return;
}
Related
Uses
| Uses | Description |
|---|---|
| is_singular() wp-includes/query.php | Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types). |
| get_query_var() wp-includes/query.php | Retrieves the value of a query variable in the WP_Query class. |
| get_previous_posts_link() wp-includes/link-template.php | Retrieves the previous posts page link. |
| get_next_posts_link() wp-includes/link-template.php | Retrieves the next posts page link. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| wp_parse_args() wp-includes/functions.php | Merges user defined arguments into defaults array. |
Used By
| Used By | Description |
|---|---|
| posts_nav_link() wp-includes/link-template.php | Displays the post pages link navigation for previous and next pages. |
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_posts_nav_link