WP_REST_Comments_Controller::check_read_post_permission( WP_Post $post, WP_REST_Request $request ): bool

Description

Compatibility

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.

$requestWP_REST_Request

Request data to check.

Return value

bool

Whether post can be read.

Performance profile

How much work a call to WP_REST_Comments_Controller::check_read_post_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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

10–64

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 69.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()one call below WP_REST_Comments_Controller::check_read_post_permission()
• hookthird-party callbacksapply_filters()one call below WP_REST_Comments_Controller::check_read_post_permission()

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 · 13 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Comments_Controller::check_read_post_permission() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• get_post_type_object()Retrieves a post type object by name.
• add_filter()Adds a callback function to a filter hook.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• current_user_can()Returns whether the current user has the specified capability.
• remove_filter()Removes a callback function from a filter hook.
• WP_REST_Posts_Controller::__construct()Constructor.

Used by · 4

• WP_REST_Comments_Controller::check_read_permission()Checks if the comment can be read.
• WP_REST_Comments_Controller::create_item_permissions_check()Checks if a given request has access to create a comment.
• WP_REST_Comments_Controller::get_item_permissions_check()Checks if a given request has access to read the comment.
• WP_REST_Comments_Controller::get_items_permissions_check()Checks if a given request has access to read comments.

Source code

View on Trac ↗View on GitHub ↗

1756	protected function check_read_post_permission( $post, $request ) {1757		$post_type = get_post_type_object( $post->post_type );1758 1759		// Return false if custom post type doesn't exist1760		if ( ! $post_type ) {1761			return false;1762		}1763 1764		$posts_controller = $post_type->get_rest_controller();1765 1766		/*1767		 * Ensure the posts controller is specifically a WP_REST_Posts_Controller instance1768		 * before using methods specific to that controller.1769		 */1770		if ( ! $posts_controller instanceof WP_REST_Posts_Controller ) {1771			$posts_controller = new WP_REST_Posts_Controller( $post->post_type );1772		}1773 1774		$has_password_filter = false;1775 1776		// Only check password if a specific post was queried for or a single comment1777		$requested_post    = ! empty( $request['post'] ) && ( ! is_array( $request['post'] ) || 1 === count( $request['post'] ) );1778		$requested_comment = ! empty( $request['id'] );1779		if ( ( $requested_post || $requested_comment ) && $posts_controller->can_access_password_content( $post, $request ) ) {1780			add_filter( 'post_password_required', '__return_false' );1781 1782			$has_password_filter = true;1783		}1784 1785		if ( post_password_required( $post ) ) {1786			$result = current_user_can( 'edit_post', $post->ID );1787		} else {1788			$result = $posts_controller->check_read_permission( $post );1789		}1790 1791		if ( $has_password_filter ) {1792			remove_filter( 'post_password_required', '__return_false' );1793		}1794 1795		return $result;1796	}

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-comments-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.