WP_REST_Posts_Controller::get_item_permissions_check() WordPress Method
The WP_REST_Posts_Controller::get_item_permissions_check() method is used to check if a given request has access to read a post. This method is important because it provides a central location for checking if a request is allowed to read a post. This is important because it helps to prevent unauthorized access to posts. This method accepts a WP_REST_Request object as its only parameter. This object contains all the information about the request, including the ID of the post being requested. This method returns a boolean value, which indicates whether or not the request is allowed to read the post.
WP_REST_Posts_Controller::get_item_permissions_check( WP_REST_Request $request ) #
Checks if a given request has access to read a post.
Parameters
- $request
(WP_REST_Request)(Required)Full details about the request.
Return
(true|WP_Error) True if the request has read access for the item, WP_Error object otherwise.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
public function get_item_permissions_check( $request ) { $post = $this->get_post( $request['id'] ); if ( is_wp_error( $post ) ) { return $post; } if ( 'edit' === $request['context'] && $post && ! $this->check_update_permission( $post ) ) { return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit this post.' ), array( 'status' => rest_authorization_required_code() ) ); } if ( $post && ! empty( $request['password'] ) ) { // Check post password, and return error if invalid. if ( ! hash_equals( $post->post_password, $request['password'] ) ) { return new WP_Error( 'rest_post_incorrect_password', __( 'Incorrect post password.' ), array( 'status' => 403 ) ); } } // Allow access to all password protected posts if the context is edit. if ( 'edit' === $request['context'] ) { add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 ); } if ( $post ) { return $this->check_read_permission( $post ); } return true; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |