Changeset 46069

Timestamp:

09/05/2019 11:04:05 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Remove extra spaces in various REST API DocBlocks.

See #47110.

Location:

trunk/src/wp-includes/rest-api

Files:

• class-wp-rest-response.php (modified) (1 diff)
• endpoints/class-wp-rest-controller.php (modified) (1 diff)
• endpoints/class-wp-rest-revisions-controller.php (modified) (1 diff)
• endpoints/class-wp-rest-settings-controller.php (modified) (1 diff)
• endpoints/class-wp-rest-taxonomies-controller.php (modified) (1 diff)
• endpoints/class-wp-rest-themes-controller.php (modified) (2 diffs)
• endpoints/class-wp-rest-users-controller.php (modified) (2 diffs)
• fields/class-wp-rest-meta-fields.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/class-wp-rest-response.php

@@ -77 +77 @@
      * @since 4.4.0
      *
-     * @param  string $rel  Link relation. Either an IANA registered type, or an absolute URL.
-     * @param  string $href Optional. Only remove links for the relation matching the given href.
-     *                      Default null.
+     * @param string $rel  Link relation. Either an IANA registered type, or an absolute URL.
+     * @param string $href Optional. Only remove links for the relation matching the given href.
+     *                     Default null.
      */
     public function remove_link( $rel, $href = null ) {

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

@@ -475 +475 @@
      * @since 4.7.0
      *
-     * @param  string $object_type Optional. The object type.
+     * @param string $object_type Optional. The object type.
      * @return array Registered additional fields (if any), empty array if none or if the object type could
      *               not be inferred.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

@@ -369 +369 @@
      * @since 4.7.0
      *
-     * @param  WP_REST_Request $request Full details about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return bool|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
      */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

@@ -305 +305 @@
      * @since 4.7.0
      *
-     * @param  mixed           $value   The value for the setting.
-     * @param  WP_REST_Request $request The request object.
-     * @param  string          $param   The parameter name.
+     * @param mixed           $value   The value for the setting.
+     * @param WP_REST_Request $request The request object.
+     * @param string          $param   The parameter name.
      * @return mixed|WP_Error
      */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php

@@ -139 +139 @@
      * @since 4.7.0
      *
-     * @param  WP_REST_Request $request Full details about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return true|WP_Error True if the request has read access for the item, otherwise false or WP_Error object.
      */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php

@@ -212 +212 @@
          * @since 5.0.0
          *
-         * @param array        $query_params JSON Schema-formatted collection parameters.
+         * @param array $query_params JSON Schema-formatted collection parameters.
          */
         return apply_filters( 'rest_themes_collection_params', $query_params );
@@ -222 +222 @@
      * @since 5.0.0
      *
-     * @param  string|array    $statuses  One or more theme statuses.
-     * @param  WP_REST_Request $request   Full details about the request.
-     * @param  string          $parameter Additional parameter to pass to validation.
+     * @param string|array    $statuses  One or more theme statuses.
+     * @param WP_REST_Request $request   Full details about the request.
+     * @param string          $parameter Additional parameter to pass to validation.
      * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
      */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -1123 +1123 @@
      * @since 4.7.0
      *
-     * @param  mixed            $value   The username submitted in the request.
-     * @param  WP_REST_Request  $request Full details about the request.
-     * @param  string           $param   The parameter name.
+     * @param mixed           $value   The username submitted in the request.
+     * @param WP_REST_Request $request Full details about the request.
+     * @param string          $param   The parameter name.
      * @return WP_Error|string The sanitized username, if valid, otherwise an error.
      */
@@ -1152 +1152 @@
      * @since 4.7.0
      *
-     * @param  mixed            $value   The password submitted in the request.
-     * @param  WP_REST_Request  $request Full details about the request.
-     * @param  string           $param   The parameter name.
+     * @param mixed           $value   The password submitted in the request.
+     * @param WP_REST_Request $request Full details about the request.
+     * @param string          $param   The parameter name.
      * @return WP_Error|string The sanitized password, if valid, otherwise an error.
      */

trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

@@ -514 +514 @@
      * @since 4.7.0
      *
-     * @param  mixed           $value   The meta value submitted in the request.
-     * @param  WP_REST_Request $request Full details about the request.
-     * @param  string          $param   The parameter name.
+     * @param mixed           $value   The meta value submitted in the request.
+     * @param WP_REST_Request $request Full details about the request.
+     * @param string          $param   The parameter name.
      * @return WP_Error|string The meta array, if valid, otherwise an error.
      */