_get_page_link( int|WP_Post $post = 0, bool $leavename = false, bool $sample = false ): string
- Since
- 2.1.0
- Source
wp-includes/link-template.php:428
Description
Ignores page_on_front. Internal use only.
Compatibility
- WordPress
- since 2.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$postint|WP_Postoptional- Post ID or object. Default uses the global
$post.Default:0 $leavenamebooloptional- Whether to keep the page name. Default false.Default:
false $samplebooloptional- Whether it should be treated as a sample permalink.
Default false.Default:false
Return value
string- The page permalink.
Performance profile
How much work a call to _get_page_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
- Heavy
- Scaling
- Constant
- Instructions
- 31–46
- Plugin surface
- 1 hook
- Called by
- 3
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 52.
Third-party callbacks on '_get_page_link' run inside this call, and their cost is not bounded by anything here.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _get_page_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 31–35 | get_post(), wp_force_plain_post_permalink(), ->get_page_permastruct(), home_url(), apply_filters() |
!empty($link) | 39–40 | get_post(), wp_force_plain_post_permalink(), ->get_page_permastruct(), home_url(), user_trailingslashit(), apply_filters() |
!empty($link) | 45–46 | get_post(), wp_force_plain_post_permalink(), ->get_page_permastruct(), get_page_uri(), home_url(), user_trailingslashit(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 52 | 31–46 | 5 | |
| 8.5 | 52 | 31–46 | 5 | |
| 8.4 | 52 | 31–46 | 5 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 55 | 31–49 | 5 | |
| 8.2 | 55 | 31–49 | 5 | |
| 8.1 | 55 | 31–49 | 5 | |
| 7.4 | 55 | 31–49 | 5 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while _get_page_link() runs, in this order:
- apply_filters( _get_page_link )filterline 456 (+28 into the body)
Filters the permalink for a non-page_on_front page.
Uses · 6
- get_post()Retrieves post data given a post ID or post object.
- wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
- get_page_uri()Builds the URI path for a page.
- home_url()Retrieves the URL for the current site where the front end is accessible.
- 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.
Used by · 3
- get_attachment_link()Retrieves the permalink for an attachment.
- get_page_link()Retrieves the permalink for the current page or page ID.
- get_post_comments_feed_link()Retrieves the permalink for the post comments feed.
Source code
function _get_page_link( $post = 0, $leavename = false, $sample = false ) { global $wp_rewrite; $post = get_post( $post ); $force_plain_link = wp_force_plain_post_permalink( $post ); $link = $wp_rewrite->get_page_permastruct(); if ( ! empty( $link ) && ( ( isset( $post->post_status ) && ! $force_plain_link ) || $sample ) ) { if ( ! $leavename ) { $link = str_replace( '%pagename%', get_page_uri( $post ), $link ); } $link = home_url( $link ); $link = user_trailingslashit( $link, 'page' ); } else { $link = home_url( '?page_id=' . $post->ID ); } /** * Filters the permalink for a non-page_on_front page. * * @since 2.1.0 * * @param string $link The page's permalink. * @param int $post_id The ID of the page. */ return apply_filters( '_get_page_link', $link, $post->ID );}Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.