get_pagenum_link( int $pagenum = 1, bool $escape = true ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$pagenumintoptional

Page number. Default 1.Default: 1

$escapebooloptional

Whether to escape the URL for display, with esc_url().
If set to false, prepares the URL with sanitize_url(). Default true.Default: true

Return value

string

The link URL for the given page number.

Performance profile

How much work a call to get_pagenum_link() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

57–127

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 152.

Plugin surface

1 hook

Third-party callbacks on 'get_pagenum_link' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below get_pagenum_link()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 10 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_pagenum_link() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_pagenum_link() runs, in this order:

1. 1
   apply_filters( get_pagenum_link )filterline 2490 (+66 into the body)

   Filters the page number link for the current request.

Uses · 11

• remove_query_arg()Removes an item or items from a query string.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• is_admin()Determines whether the current request is for an administrative interface page.
• trailingslashit()Appends a trailing slash.
• get_bloginfo()Retrieves information about the current site.
• add_query_arg()Retrieves a modified URL query string.
• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_url()Checks and cleans a URL.
• sanitize_url()Sanitizes a URL for database or redirect usage.

Used by · 4

• get_next_posts_page_link()Retrieves the next posts page link.
• get_previous_posts_page_link()Retrieves the previous posts page link.
• paginate_links()Retrieves paginated links for archive post pages.
• twentyfourteen_paging_nav()Display navigation to next/previous set of posts when applicable.

Source code

View on Trac ↗View on GitHub ↗

2424function get_pagenum_link( $pagenum = 1, $escape = true ) {2425	global $wp_rewrite;2426 2427	$pagenum = (int) $pagenum;2428 2429	$request = remove_query_arg( 'paged' );2430 2431	$home_root = parse_url( home_url() );2432	$home_root = ( isset( $home_root['path'] ) ) ? $home_root['path'] : '';2433	$home_root = preg_quote( $home_root, '|' );2434 2435	$request = preg_replace( '|^' . $home_root . '|i', '', $request );2436	$request = preg_replace( '|^/+|', '', $request );2437 2438	if ( ! $wp_rewrite->using_permalinks() || is_admin() ) {2439		$base = trailingslashit( get_bloginfo( 'url' ) );2440 2441		if ( $pagenum > 1 ) {2442			$result = add_query_arg( 'paged', $pagenum, $base . $request );2443		} else {2444			$result = $base . $request;2445		}2446	} else {2447		$qs_regex = '|\?.*?$|';2448		preg_match( $qs_regex, $request, $qs_match );2449 2450		$parts   = array();2451		$parts[] = untrailingslashit( get_bloginfo( 'url' ) );2452 2453		if ( ! empty( $qs_match[0] ) ) {2454			$query_string = $qs_match[0];2455			$request      = preg_replace( $qs_regex, '', $request );2456		} else {2457			$query_string = '';2458		}2459 2460		$request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request );2461		$request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request );2462		$request = ltrim( $request, '/' );2463 2464		if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' !== $request ) ) {2465			$parts[] = $wp_rewrite->index;2466		}2467 2468		$parts[] = untrailingslashit( $request );2469 2470		if ( $pagenum > 1 ) {2471			$parts[] = $wp_rewrite->pagination_base;2472			$parts[] = $pagenum;2473		}2474 2475		$result = user_trailingslashit( implode( '/', array_filter( $parts ) ), 'paged' );2476		if ( ! empty( $query_string ) ) {2477			$result .= $query_string;2478		}2479	}2480 2481	/**2482	 * Filters the page number link for the current request.2483	 *2484	 * @since 2.5.02485	 * @since 5.2.0 Added the `$pagenum` argument.2486	 *2487	 * @param string $result  The page number link.2488	 * @param int    $pagenum The page number.2489	 */2490	$result = apply_filters( 'get_pagenum_link', $result, $pagenum );2491 2492	if ( $escape ) {2493		return esc_url( $result );2494	} else {2495		return sanitize_url( $result );2496	}2497}

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.