Docs: Add much more complete and syntactically correct documentation throughout the `WP_REST_Post_Statuses_Controller` class.

Props Soean, mrahmadawais, flixos90.
See #38398.

Built from https://develop.svn.wordpress.org/trunk@39024


git-svn-id: http://core.svn.wordpress.org/trunk@38966 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php

@@ -1,34 +1,59 @@
 <?php
+/**
+ * REST API: WP_REST_Post_Statuses_Controller class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 4.7.0
+ */
 
+/**
+ * Core class used to access post statuses via the REST API.
+ *
+ * @since 4.7.0
+ *
+ * @see WP_REST_Controller
+ */
 class WP_REST_Post_Statuses_Controller extends WP_REST_Controller {
 
+	/**
+	 * Constructor.
+	 *
+	 * @since 4.7.0
+	 * @access public
+	 */
 	public function __construct() {
 		$this->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,
+				'methods'             => WP_REST_Server::READABLE,
-				'callback'        => array( $this, 'get_items' ),
+				'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<status>[\w-]+)', array(
 			array(
-				'methods'         => WP_REST_Server::READABLE,
+				'methods'             => WP_REST_Server::READABLE,
-				'callback'        => array( $this, 'get_item' ),
+				'callback'            => array( $this, 'get_item' ),
 				'permission_callback' => array( $this, 'get_item_permissions_check' ),
-				'args'            => array(
+				'args'                => array(
-					'context'          => $this->get_context_param( array( 'default' => 'view' ) ),
+					'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.
+	 * @since 4.7.0
-	 * @return WP_Error|boolean
+	 * @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
+	 * @since 4.7.0
-	 * @return array|WP_Error
+	 * @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.
+	 * @since 4.7.0
-	 * @return WP_Error|boolean
+	 * @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
+	 * @since 4.7.0
-	 * @return boolean
+	 * @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
+	 * @since 4.7.0
-	 * @return array|WP_Error
+	 * @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
+	 * @since 4.7.0
-	 * @param WP_REST_Request $request
+	 * @access public
-	 * @return WP_REST_Response Post status data
+	 *
+	 * @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.
+		 * @since 4.7.0
-		 * @param object            $status   The original status object.
+		 *
-		 * @param WP_REST_Request   $request  Request used to generate the response.
+		 * @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' ) ),
 		);
 	}
 

wp-includes/version.php

@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.7-beta1-39023';
+$wp_version = '4.7-beta1-39024';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.