WP_REST_Posts_Controller::check_read_permission( WP_Post $post ): bool
- Since
- 4.7.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:1784
Description
Correctly handles posts with the inherit status.
Compatibility
- WordPress
- since 4.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
$postWP_Post- Post object.
Return value
bool- Whether the post can be read.
Performance profile
How much work a call to WP_REST_Posts_Controller::check_read_permission() 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–47
- 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 55.
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
Further down the call graph this can also reach hook, 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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Posts_Controller::check_read_permission() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12–15 | get_post_type_object(), ->check_is_post_type_allowed() |
->check_is_post_type_allowed() && current_user_can() | 22 | get_post_type_object(), ->check_is_post_type_allowed(), current_user_can() |
->check_is_post_type_allowed() && !current_user_can() | 31–40 | get_post_type_object(), ->check_is_post_type_allowed(), current_user_can(), get_post_status_object() |
->check_is_post_type_allowed() && !current_user_can() | 45–47 | get_post_type_object(), ->check_is_post_type_allowed(), current_user_can(), get_post_status_object(), get_post() |
->check_is_post_type_allowed() && !current_user_can() | 45–47 | get_post_type_object(), ->check_is_post_type_allowed(), current_user_can(), get_post_status_object(), get_post(), ->check_read_permission() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 55 instructions, 12–47 executed per call, 9 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 · 6
- get_post_type_object()Retrieves a post type object by name.
- current_user_can()Returns whether the current user has the specified capability.
- get_post_status_object()Retrieves a post status object by name.
- get_post()Retrieves post data given a post ID or post object.
- WP_REST_Posts_Controller::check_is_post_type_allowed()Checks if a given post type can be viewed or managed.
- WP_REST_Posts_Controller::check_read_permission()Checks if a post can be read.
Used by · 4
- WP_REST_Blocks_Controller::check_read_permission()Checks if a pattern can be read.
- WP_REST_Posts_Controller::check_read_permission()Checks if a post can be read.
- WP_REST_Posts_Controller::get_item_permissions_check()Checks if a given request has access to read a post.
- WP_REST_Posts_Controller::get_items()Retrieves a collection of posts.
Source code
public function check_read_permission( $post ) { $post_type = get_post_type_object( $post->post_type ); if ( ! $this->check_is_post_type_allowed( $post_type ) ) { return false; } // Is the post readable? if ( 'publish' === $post->post_status || current_user_can( 'read_post', $post->ID ) ) { return true; } $post_status_obj = get_post_status_object( $post->post_status ); if ( $post_status_obj && $post_status_obj->public ) { return true; } // Can we read the parent if we're inheriting? if ( 'inherit' === $post->post_status && $post->post_parent > 0 ) { $parent = get_post( $post->post_parent ); if ( $parent ) { return $this->check_read_permission( $parent ); } } /* * If there isn't a parent, but the status is set to inherit, assume * it's published (as per get_post_status()). */ if ( 'inherit' === $post->post_status ) { return true; } return false; }Changelog
Introduced in 4.7.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/rest-api/endpoints/class-wp-rest-posts-controller.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.