get_post_format_link( string $format ): string|WP_Error|false
- Since
- 3.1.0
- Source
wp-includes/post-formats.php:149
Compatibility
- WordPress
- since 3.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
$formatstring- The post format slug.
Return value
string|WP_Error|false- The post format term link.
Performance profile
How much work a call to get_post_format_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
- 10–17
- Plugin surface
- None
- Called by
- 5
Reaches the database via get_term().
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 18.
Nothing here hands control to plugin code.
5 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_term()one call below get_post_format_link() - hookthird-party callbacks
do_action()one call below get_post_format_link()
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_post_format_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10 | get_term_by() |
is_wp_error() | 14 | get_term_by(), is_wp_error() |
!is_wp_error() | 17 | get_term_by(), is_wp_error(), get_term_link() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 10–17 executed per call, 2 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 · 3
- get_term_by()Gets all term data from database by term field and data.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- get_term_link()Generates a permalink for a taxonomy term archive.
Used by · 5
- Twenty_Fourteen_Ephemera_Widget::widget()Output the HTML for this widget.
- WP_REST_Post_Format_Search_Handler::prepare_item()Prepares the search result for a given post format.
- WP_REST_Post_Format_Search_Handler::search_items()Searches the post formats for a given search request.
- twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
- twentysixteen_entry_meta()Prints HTML with meta information for the categories, tags.
Source code
function get_post_format_link( $format ) { $term = get_term_by( 'slug', 'post-format-' . $format, 'post_format' ); if ( ! $term || is_wp_error( $term ) ) { return false; } return get_term_link( $term );}Changelog
Introduced in 3.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 6.8.8 tag, from
src/wp-includes/post-formats.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.