WP_REST_Comments_Controller::check_target_post_permission( int $post_id ): 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.

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

11–25

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place 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 · 6 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 · 5

• __()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.

Used by · 1

• 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 ↗

1945	protected function check_target_post_permission( $post_id ) {1946		if ( ! $post_id ) {1947			return new WP_Error(1948				'rest_comment_invalid_post_id',1949				__( 'Sorry, you are not allowed to create this comment without a post.' ),1950				array( 'status' => 403 )1951			);1952		}1953 1954		/*1955		 * A comment needs either comment moderation rights or edit access to the1956		 * post, which is what check_edit_permission() grants on the post a comment1957		 * is moving away from. Requiring the same at the destination means both1958		 * ends of a move are authorized alike.1959		 */1960		if ( ! current_user_can( 'moderate_comments' ) && ! current_user_can( 'edit_post', $post_id ) ) {1961			return new WP_Error(1962				'rest_cannot_edit',1963				__( 'Sorry, you are not allowed to edit this comment.' ),1964				array( 'status' => rest_authorization_required_code() )1965			);1966		}1967 1968		$post = get_post( $post_id );1969 1970		if ( ! $post ) {1971			return new WP_Error(1972				'rest_comment_invalid_post_id',1973				__( 'Sorry, you are not allowed to create this comment without a post.' ),1974				array( 'status' => 403 )1975			);1976		}1977 1978		/*1979		 * The create-time draft and comments-open rules are deliberately not applied1980		 * here, because moderators move comments onto posts whose discussion has1981		 * closed and onto drafts today. Enforcing them would break that without1982		 * blocking anything the capability check above already permits.1983		 */1984		return true;1985	}

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.7.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.