get_the_permalink( int|WP_Post $post = 0, bool $leavename = false ): string|false
- Since
- 3.9.0
- Source
wp-includes/link-template.php:157
Description
This function is an alias for get_permalink().
Compatibility
- WordPress
- since 3.9.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 post object. Default is the global
$post.Default:0 $leavenamebooloptional- Whether to keep post name or page name. Default false.Default:
false
Return value
string|false- The permalink URL. False if the post does not exist.
Performance profile
How much work a call to get_the_permalink() 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
- 7
- Plugin surface
- None
- Called by
- 6
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. The body compiles to 7.
Nothing here hands control to plugin code.
6 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()one call below get_the_permalink() - optionoption read or write
get_option()one call below get_the_permalink() - hookthird-party callbacks
apply_filters()one call below get_the_permalink()
Further down the call graph this can also reach 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_the_permalink() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | get_permalink() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 7 instructions, 7 executed per call, 0 branches. The work does not change between versions.
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.
Uses · 1
- get_permalink()Retrieves the full permalink for the current post or post ID.
Used by · 6
- _wp_dashboard_recent_comments_row()Outputs a row for the Recent Comments widget.
- render_block_core_post_date()Renders the `core/post-date` block on the server.
- render_block_core_post_excerpt()Renders the `core/post-excerpt` block on the server.
- render_block_core_post_featured_image()Renders the `core/post-featured-image` block on the server.
- render_block_core_post_title()Renders the `core/post-title` block on the server.
- render_block_core_read_more()Renders the `core/read-more` block on the server.
Source code
function get_the_permalink( $post = 0, $leavename = false ) { return get_permalink( $post, $leavename );}Changelog
Introduced in 3.9.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 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.