WP_REST_Posts_Controller::handle_status_param( string $post_status, WP_Post_Type $post_type ): string|WP_Error

In this article

Determines validity and normalizes the given status parameter.

Parameters

$post_statusstringrequired
Post status.
$post_typeWP_Post_Typerequired
Post type.

Return

string|WP_Error Post status or WP_Error if lacking the proper permission.

Source

protected function handle_status_param( $post_status, $post_type ) {

	switch ( $post_status ) {
		case 'draft':
		case 'pending':
			break;
		case 'private':
			if ( ! current_user_can( $post_type->cap->publish_posts ) ) {
				return new WP_Error(
					'rest_cannot_publish',
					__( 'Sorry, you are not allowed to create private posts in this post type.' ),
					array( 'status' => rest_authorization_required_code() )
				);
			}
			break;
		case 'publish':
		case 'future':
			if ( ! current_user_can( $post_type->cap->publish_posts ) ) {
				return new WP_Error(
					'rest_cannot_publish',
					__( 'Sorry, you are not allowed to publish posts in this post type.' ),
					array( 'status' => rest_authorization_required_code() )
				);
			}
			break;
		default:
			if ( ! get_post_status_object( $post_status ) ) {
				$post_status = 'draft';
			}
			break;
	}

	return $post_status;
}

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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