wp_force_plain_post_permalink( int|WP_Post|null $post = null, bool|null $sample = null ): bool
- Since
- 5.7.0
- Source
wp-includes/link-template.php:103
Compatibility
- WordPress
- since 5.7.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_Post|nulloptional- Post ID or post object. Defaults to global $post.Default:
null $samplebool|nulloptional- Whether to force consideration based on sample links.
If omitted, a sample link is generated if a post object is passed with the filter property set to 'sample'.Default:null
Return value
bool- Whether to use a plain permalink structure.
Performance profile
How much work a call to wp_force_plain_post_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
- 12–52
- Plugin surface
- None
- Called by
- 4
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 57.
Nothing here hands control to plugin code.
4 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()one call below wp_force_plain_post_permalink()
Further down the call graph this can also reach cache, serialize, option 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 · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_force_plain_post_permalink() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12–20 | get_post() |
$sample === null && is_object($post) && isset($post) | 15 | none |
| always | 27–36 | get_post(), get_post_status(), get_post_status_object(), get_post_type(), get_post_type_object() |
$sample === null && is_object($post) && isset($post) | 30–31 | get_post_status(), get_post_status_object(), get_post_type(), get_post_type_object() |
| always | 32–45 | get_post(), get_post_status(), get_post_status_object(), get_post_type(), get_post_type_object(), is_post_status_viewable() |
$sample === null && is_object($post) && isset($post) | 35–40 | get_post_status(), get_post_status_object(), get_post_type(), get_post_type_object(), is_post_status_viewable() |
!is_post_status_viewable() && $post_status_obj | 41–52 | get_post(), get_post_status(), get_post_status_object(), get_post_type(), get_post_type_object(), is_post_status_viewable(), current_user_can() |
$sample === null && is_object($post) && isset($post) && !is_post_status_viewable() && $post_status_obj | 44–47 | get_post_status(), get_post_status_object(), get_post_type(), get_post_type_object(), is_post_status_viewable(), current_user_can() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 57 instructions, 12–52 executed per call, 13 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 · 7
- get_post()Retrieves post data given a post ID or post object.
- get_post_status_object()Retrieves a post status object by name.
- get_post_status()Retrieves the post status based on the post ID.
- get_post_type_object()Retrieves a post type object by name.
- get_post_type()Retrieves the post type of the current post or of a given post.
- is_post_status_viewable()Determines whether a post status is considered "viewable".
- current_user_can()Returns whether the current user has the specified capability.
Used by · 4
- _get_page_link()Retrieves the page permalink.
- get_attachment_link()Retrieves the permalink for an attachment.
- get_permalink()Retrieves the full permalink for the current post or post ID.
- get_post_permalink()Retrieves the permalink for a post of a custom post type.
Source code
function wp_force_plain_post_permalink( $post = null, $sample = null ) { if ( null === $sample && is_object( $post ) && isset( $post->filter ) && 'sample' === $post->filter ) { $sample = true; } else { $post = get_post( $post ); $sample = $sample ?? false; } if ( ! $post ) { return true; } $post_status_obj = get_post_status_object( get_post_status( $post ) ); $post_type_obj = get_post_type_object( get_post_type( $post ) ); if ( ! $post_status_obj || ! $post_type_obj ) { return true; } if ( // Publicly viewable links never have plain permalinks. is_post_status_viewable( $post_status_obj ) || ( // Private posts don't have plain permalinks if the user can read them. $post_status_obj->private && current_user_can( 'read_post', $post->ID ) ) || // Protected posts don't have plain links if getting a sample URL. ( $post_status_obj->protected && $sample ) ) { return false; } return true;}Changelog
Introduced in 5.7.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post retyped from WP_Post|int|null to int|WP_Post|null.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.