On this page
WP_REST_Post_Statuses_Controller::get_item_permissions_check( WP_REST_Request $request ): true|WP_Error
Checks if a given request has access to read a post status.
Parameters
$requestWP_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-post-statuses-controller.php. View all references
public function get_item_permissions_check( $request ) {
$status = get_post_status_object( $request['status'] );
if ( empty( $status ) ) {
return new WP_Error(
'rest_status_invalid',
__( 'Invalid status.' ),
array( 'status' => 404 )
);
}
$check = $this->check_read_permission( $status );
if ( ! $check ) {
return new WP_Error(
'rest_cannot_read_status',
__( 'Cannot view status.' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Post_Statuses_Controller::check_read_permission() wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php | Checks whether a given post status should be visible. |
| get_post_status_object() wp-includes/post.php | Retrieves a post status object by name. |
| rest_authorization_required_code() wp-includes/rest-api.php | Returns a contextual HTTP error code for authorization failure. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_post_statuses_controller/get_item_permissions_check