From 9b648569f234df2a32e09093255dd406f77d9bf2 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 30 Oct 2016 16:43:12 +0000 Subject: [PATCH] Docs: Add much more complete and syntactically correct documentation throughout the `WP_REST_Post_Statuses_Controller` class. Props Soean, mrahmadawais, flixos90. See #38398. git-svn-id: https://develop.svn.wordpress.org/trunk@39024 602fd350-edb4-49c9-b593-d223f7449a82 --- ...class-wp-rest-post-statuses-controller.php | 140 +++++++++++++----- 1 file changed, 104 insertions(+), 36 deletions(-) diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php index faf73f0ea2..13ffee0095 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php @@ -1,34 +1,59 @@ namespace = 'wp/v2'; $this->rest_base = 'statuses'; } /** - * Register the routes for the objects of the controller. + * Registers the routes for the objects of the controller. + * + * @since 4.7.0 + * @access public + * + * @see register_rest_route() */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base, array( array( - 'methods' => WP_REST_Server::READABLE, - 'callback' => array( $this, 'get_items' ), + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_items' ), 'permission_callback' => array( $this, 'get_items_permissions_check' ), - 'args' => $this->get_collection_params(), + 'args' => $this->get_collection_params(), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P[\w-]+)', array( array( - 'methods' => WP_REST_Server::READABLE, - 'callback' => array( $this, 'get_item' ), + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_item_permissions_check' ), - 'args' => array( - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), + 'args' => array( + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), ), ), 'schema' => array( $this, 'get_public_item_schema' ), @@ -36,14 +61,18 @@ class WP_REST_Post_Statuses_Controller extends WP_REST_Controller { } /** - * Check whether a given request has permission to read post statuses. + * Checks whether a given request has permission to read post statuses. * - * @param WP_REST_Request $request Full details about the request. - * @return WP_Error|boolean + * @since 4.7.0 + * @access public + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has read access, WP_Error object otherwise. */ public function get_items_permissions_check( $request ) { if ( 'edit' === $request['context'] ) { $types = get_post_types( array( 'show_in_rest' => true ), 'objects' ); + foreach ( $types as $type ) { if ( current_user_can( $type->cap->edit_posts ) ) { return true; @@ -51,90 +80,120 @@ class WP_REST_Post_Statuses_Controller extends WP_REST_Controller { } return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource with edit context.' ), array( 'status' => rest_authorization_required_code() ) ); } + return true; } /** - * Get all post statuses, depending on user context + * Retrieves all post statuses, depending on user context. * - * @param WP_REST_Request $request - * @return array|WP_Error + * @since 4.7.0 + * @access public + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. */ public function get_items( $request ) { $data = array(); $statuses = get_post_stati( array( 'internal' => false ), 'object' ); $statuses['trash'] = get_post_status_object( 'trash' ); + foreach ( $statuses as $slug => $obj ) { $ret = $this->check_read_permission( $obj ); + if ( ! $ret ) { continue; } + $status = $this->prepare_item_for_response( $obj, $request ); $data[ $obj->name ] = $this->prepare_response_for_collection( $status ); } + return rest_ensure_response( $data ); } /** - * Check if a given request has access to read a post status. + * Checks if a given request has access to read a post status. * - * @param WP_REST_Request $request Full details about the request. - * @return WP_Error|boolean + * @since 4.7.0 + * @access public + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has read access for the item, WP_Error object otherwise. */ public function get_item_permissions_check( $request ) { $status = get_post_status_object( $request['status'] ); + if ( empty( $status ) ) { return new WP_Error( 'rest_status_invalid', __( 'Invalid resource.' ), array( 'status' => 404 ) ); } + $check = $this->check_read_permission( $status ); + if ( ! $check ) { return new WP_Error( 'rest_cannot_read_status', __( 'Cannot view resource.' ), array( 'status' => rest_authorization_required_code() ) ); } + return true; } /** - * Check whether a given post status should be visible + * Checks whether a given post status should be visible. * - * @param object $status - * @return boolean + * @since 4.7.0 + * @access protected + * + * @param object $status Post status. + * @return bool True if the post status is visible, otherwise false. */ protected function check_read_permission( $status ) { if ( true === $status->public ) { return true; } + if ( false === $status->internal || 'trash' === $status->name ) { $types = get_post_types( array( 'show_in_rest' => true ), 'objects' ); + foreach ( $types as $type ) { if ( current_user_can( $type->cap->edit_posts ) ) { return true; } } } + return false; } /** - * Get a specific post status + * Retrieves a specific post status. * - * @param WP_REST_Request $request - * @return array|WP_Error + * @since 4.7.0 + * @access public + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. */ public function get_item( $request ) { $obj = get_post_status_object( $request['status'] ); + if ( empty( $obj ) ) { return new WP_Error( 'rest_status_invalid', __( 'Invalid resource.' ), array( 'status' => 404 ) ); } + $data = $this->prepare_item_for_response( $obj, $request ); + return rest_ensure_response( $data ); } /** - * Prepare a post status object for serialization + * Prepares a post status object for serialization. * - * @param stdClass $status Post status data - * @param WP_REST_Request $request - * @return WP_REST_Response Post status data + * @since 4.7.0 + * @access public + * + * @param stdClass $status Post status data. + * @param WP_REST_Request $request Full details about the request. + * @return WP_REST_Response Post status data. */ public function prepare_item_for_response( $status, $request ) { @@ -161,21 +220,26 @@ class WP_REST_Post_Statuses_Controller extends WP_REST_Controller { } /** - * Filter a status returned from the API. + * Filters a status returned from the REST API. * * Allows modification of the status data right before it is returned. * - * @param WP_REST_Response $response The response object. - * @param object $status The original status object. - * @param WP_REST_Request $request Request used to generate the response. + * @since 4.7.0 + * + * @param WP_REST_Response $response The response object. + * @param object $status The original status object. + * @param WP_REST_Request $request Request used to generate the response. */ return apply_filters( 'rest_prepare_status', $response, $status, $request ); } /** - * Get the Post status' schema, conforming to JSON Schema + * Retrieves the post status' schema, conforming to JSON Schema. * - * @return array + * @since 4.7.0 + * @access public + * + * @return array Item schema data. */ public function get_item_schema() { $schema = array( @@ -227,17 +291,21 @@ class WP_REST_Post_Statuses_Controller extends WP_REST_Controller { ), ), ); + return $this->add_additional_fields_schema( $schema ); } /** - * Get the query params for collections + * Retrieves the query params for collections. * - * @return array + * @since 4.7.0 + * @access public + * + * @return array Collection parameters. */ public function get_collection_params() { return array( - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), ); }