WP_REST_Comments_Controller::check_target_post_permission( int $post_id, WP_REST_Request $request, bool $is_note = false ): true|WP_Error

Description

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_idint

Target post ID.

$requestWP_REST_Request

Full details about the request.

$is_notebooloptional

Whether the comment is a note. Default false.Default: false

Return value

true|WP_Error

True if the post can receive the comment, error object otherwise.

Performance profile

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

13–48

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What it touches

• querycontent queryget_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 · 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_target_post_permission() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
• get_post()Retrieves post data given a post ID or post object.
• WP_Error::__construct()Initializes the error.
• WP_REST_Comments_Controller::check_post_type_supports_notes()Check if post type supports notes.
• WP_REST_Comments_Controller::check_read_post_permission()Checks if the post can be read.

Used by · 2

• WP_REST_Comments_Controller::create_item_permissions_check()Checks if a given request has access to create a comment.
• WP_REST_Comments_Controller::update_item_permissions_check()Checks if a given REST request has access to update a comment.

Source code

View on Trac ↗View on GitHub ↗

2081	protected function check_target_post_permission( int $post_id, WP_REST_Request $request, bool $is_note = false ) {2082		if ( ! $post_id ) {2083			return new WP_Error(2084				'rest_comment_invalid_post_id',2085				__( 'Sorry, you are not allowed to create this comment without a post.' ),2086				array( 'status' => 403 )2087			);2088		}2089 2090		/*2091		 * Notes are editorial content, so they may only be attached to a post the2092		 * user can edit. Any other comment needs either comment moderation rights2093		 * or edit access to the post, which is what check_edit_permission() grants2094		 * on the post a comment is moving away from. Requiring the same at the2095		 * destination means both ends of a move are authorized alike.2096		 */2097		if ( $is_note ) {2098			$can_target_post = current_user_can( 'edit_post', $post_id );2099		} else {2100			$can_target_post = current_user_can( 'moderate_comments' ) || current_user_can( 'edit_post', $post_id );2101		}2102 2103		if ( ! $can_target_post ) {2104			if ( $is_note ) {2105				return new WP_Error(2106					'rest_cannot_create_note',2107					__( 'Sorry, you are not allowed to create notes for this post.' ),2108					array( 'status' => rest_authorization_required_code() )2109				);2110			}2111 2112			return new WP_Error(2113				'rest_cannot_edit',2114				__( 'Sorry, you are not allowed to edit this comment.' ),2115				array( 'status' => rest_authorization_required_code() )2116			);2117		}2118 2119		$post = get_post( $post_id );2120 2121		if ( ! $post ) {2122			return new WP_Error(2123				'rest_comment_invalid_post_id',2124				__( 'Sorry, you are not allowed to create this comment without a post.' ),2125				array( 'status' => 403 )2126			);2127		}2128 2129		/*2130		 * The remaining rules mirror the create-time checks for notes only. They are2131		 * deliberately not applied to other comments, because moderators move comments2132		 * onto posts whose discussion has closed and onto drafts today. Enforcing the2133		 * create-time rules there would break that without blocking anything the2134		 * capability check above already permits.2135		 */2136		if ( ! $is_note ) {2137			return true;2138		}2139 2140		if ( ! $this->check_post_type_supports_notes( $post->post_type ) ) {2141			return new WP_Error(2142				'rest_comment_not_supported_post_type',2143				__( 'Sorry, this post type does not support notes.' ),2144				array( 'status' => 403 )2145			);2146		}2147 2148		if ( 'trash' === $post->post_status ) {2149			return new WP_Error(2150				'rest_comment_trash_post',2151				__( 'Sorry, you are not allowed to create a comment on this post.' ),2152				array( 'status' => 403 )2153			);2154		}2155 2156		if ( ! $this->check_read_post_permission( $post, $request ) ) {2157			return new WP_Error(2158				'rest_cannot_read_post',2159				__( 'Sorry, you are not allowed to read the post for this comment.' ),2160				array( 'status' => rest_authorization_required_code() )

Changelog

Introduced in 7.1.0. 2 changes between 6.7.10 and 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.9.10 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.