WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Posts_Controller::check_status()

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

In this article

Back to top

Checks whether the status is valid for the given post.

Description

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

Parameters

$statusstringrequired
The provided status.
$requestWP_REST_Requestrequired
The request object.
$paramstringrequired
The parameter name.

Return

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

Source

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

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Posts_Controller::get_post()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Gets the post, if the ID is valid.

rest_validate_value_from_schema()wp-includes/rest-api.php

Validate a value based on a schema.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less

Changelog

VersionDescription
5.6.0Introduced.

User Contributed Notes

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