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.
Parameters Parameters
- $status
-
(string) (Required) The provided status.
- $request
-
(WP_REST_Request) (Required) The request object.
- $param
-
(string) (Required) The parameter name.
Return Return
(true|WP_Error) True if the status is valid, or WP_Error if not.
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 );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 5.6.0 | Introduced. |