WP_REST_Posts_Controller::check_status( string $status, WP_REST_Request $request, string $param )

Checks whether the status is valid for the given post.

Description Description

Allows for sending an update request with the current status, even if that status would not be acceptable.

Top ↑

Parameters Parameters


(string) (Required) The provided status.


(WP_REST_Request) (Required) The request object.


(string) (Required) The parameter name.

Top ↑

Return Return

(true|WP_Error) True if the status is valid, or WP_Error if not.

Top ↑

Source Source

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

	public function check_status( $status, $request, $param ) {
		if ( $request['id'] ) {
			$post = $this->get_post( $request['id'] );

			if ( ! is_wp_error( $post ) && $post->post_status === $status ) {
				return true;

		$args = $request->get_attributes()['args'][ $param ];

		return rest_validate_value_from_schema( $status, $args, $param );

Top ↑

Changelog Changelog

Version Description
5.6.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.