W3cubDocs

/WordPress

WP_REST_Post_Statuses_Controller::get_item( WP_REST_Request $request )

Retrieves a specific post status.

Description

Parameters

$request

(WP_REST_Request) (Required) Full details about the request.

Return

(WP_Error|WP_REST_Response) Response object on success, or WP_Error object on failure.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php

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 );
	}

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_post_statuses_controller/get_item