WP_REST_Comments_Controller::get_items_permissions_check( WP_REST_Request $request ): true|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

true|WP_Error

True if the request has read access, error object otherwise.

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

10–44

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

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

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

Uses · 6

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

Source code

View on Trac ↗View on GitHub ↗

125	public function get_items_permissions_check( $request ) {126 127		if ( ! empty( $request['post'] ) ) {128			foreach ( (array) $request['post'] as $post_id ) {129				$post = get_post( $post_id );130 131				if ( ! empty( $post_id ) && $post && ! $this->check_read_post_permission( $post, $request ) ) {132					return new WP_Error(133						'rest_cannot_read_post',134						__( 'Sorry, you are not allowed to read the post for this comment.' ),135						array( 'status' => rest_authorization_required_code() )136					);137				} elseif ( 0 === $post_id && ! current_user_can( 'moderate_comments' ) ) {138					return new WP_Error(139						'rest_cannot_read',140						__( 'Sorry, you are not allowed to read comments without a post.' ),141						array( 'status' => rest_authorization_required_code() )142					);143				}144			}145		}146 147		if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'moderate_comments' ) ) {148			return new WP_Error(149				'rest_forbidden_context',150				__( 'Sorry, you are not allowed to edit comments.' ),151				array( 'status' => rest_authorization_required_code() )152			);153		}154 155		if ( ! current_user_can( 'edit_posts' ) ) {156			$protected_params = array( 'author', 'author_exclude', 'author_email', 'type', 'status' );157			$forbidden_params = array();158 159			foreach ( $protected_params as $param ) {160				if ( 'status' === $param ) {161					if ( 'approve' !== $request[ $param ] ) {162						$forbidden_params[] = $param;163					}164				} elseif ( 'type' === $param ) {165					if ( 'comment' !== $request[ $param ] ) {166						$forbidden_params[] = $param;167					}168				} elseif ( ! empty( $request[ $param ] ) ) {169					$forbidden_params[] = $param;170				}171			}172 173			if ( ! empty( $forbidden_params ) ) {174				return new WP_Error(175					'rest_forbidden_param',176					/* translators: %s: List of forbidden parameters. */177					sprintf( __( 'Query parameter not permitted: %s' ), implode( ', ', $forbidden_params ) ),178					array( 'status' => rest_authorization_required_code() )179				);180			}181		}182 183		return true;184	}

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.