get_post_format_string( string $slug ): string
- Since
- 3.1.0
- Source
wp-includes/post-formats.php:132
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
$slugstring- A post format slug.
Return value
string- The translated post format name.
Performance profile
How much work a call to get_post_format_string() 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
- Trivial
- Scaling
- Constant
- Instructions
- 7–9
- Plugin surface
- None
- Called by
- 13
Touches nothing outside its own arguments.
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 12.
Nothing here hands control to plugin code.
13 places in core call this, so the cost is paid more often than your own code shows.
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_post_format_string() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7–9 | get_post_format_strings() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 7–9 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 · 1
- get_post_format_strings()Returns an array of post format slugs to their translated and pretty display versions
Used by · 13
- Twenty_Fourteen_Ephemera_Widget::form()Display the form for this widget on the Widgets page of the Admin area.
- WP_Posts_List_Table::formats_dropdown()Displays a formats drop-down for filtering items.
- WP_Posts_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
- 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.
- _post_format_get_term()Remove the post format prefix from the name property of the term object created by get_term().
- _post_format_get_terms()Remove the post format prefix from the name property of the term objects created by get_terms().
- _post_format_wp_get_object_terms()Remove the post format prefix from the name property of the term objects created by wp_get_object_terms().
- post_format_meta_box()Displays post format form elements.
- twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
- twentysixteen_entry_meta()Prints HTML with meta information for the categories, tags.
- twentythirteen_entry_date()Print HTML with date information for current post.
Show all 13
- twentytwentyfive_format_binding()Callback function for the post format name block binding source.
Source code
function get_post_format_string( $slug ) { $strings = get_post_format_strings(); if ( ! $slug ) { return $strings['standard']; } else { return ( isset( $strings[ $slug ] ) ) ? $strings[ $slug ] : ''; }}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.