On this page
WP_REST_Post_Statuses_Controller::get_item( WP_REST_Request $request ): WP_REST_Response|WP_Error
Retrieves a specific post status.
Parameters
$requestWP_REST_Request Required-
Full details about the request.
Return
WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php. View all references
public function get_item( $request ) {
$obj = get_post_status_object( $request['status'] );
if ( empty( $obj ) ) {
return new WP_Error(
'rest_status_invalid',
__( 'Invalid status.' ),
array( 'status' => 404 )
);
}
$data = $this->prepare_item_for_response( $obj, $request );
return rest_ensure_response( $data );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Post_Statuses_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php | Prepares a post status object for serialization. |
| get_post_status_object() wp-includes/post.php | Retrieves a post status object by name. |
| rest_ensure_response() wp-includes/rest-api.php | Ensures a REST response is a response object (for consistency). |
| __() 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