Changeset 51278

Timestamp:

06/30/2021 12:33:43 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document the globals used in some REST API methods.

See #53399.

Location:

trunk/src/wp-includes

Files:

• rest-api.php (modified) (3 diffs)
• rest-api/endpoints/class-wp-rest-block-renderer-controller.php (modified) (4 diffs)
• rest-api/endpoints/class-wp-rest-controller.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-plugins-controller.php (modified) (3 diffs)
• rest-api/endpoints/class-wp-rest-users-controller.php (modified) (1 diff)

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

@@ -119 +119 @@
  *                                          by object type.
  *
- * @param string|array $object_type Object(s) the field is being registered
- *                                  to, "post"|"term"|"comment" etc.
+ * @param string|array $object_type Object(s) the field is being registered to,
+ *                                  "post"|"term"|"comment" etc.
  * @param string       $attribute   The attribute name.
  * @param array        $args {
@@ -136 +136 @@
  */
 function register_rest_field( $object_type, $attribute, $args = array() ) {
+    global $wp_rest_additional_fields;
+
     $defaults = array(
         'get_callback'    => null,
@@ -143 +145 @@
 
     $args = wp_parse_args( $args, $defaults );
-
-    global $wp_rest_additional_fields;
 
     $object_types = (array) $object_type;

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

@@ -104 +104 @@
      * @since 5.0.0
      *
+     * @global WP_Post $post Global post object.
+     *
      * @param WP_REST_Request $request Request.
      * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
@@ -112 +114 @@
         $post_id = isset( $request['post_id'] ) ? (int) $request['post_id'] : 0;
 
-        if ( 0 < $post_id ) {
+        if ( $post_id > 0 ) {
             $post = get_post( $post_id );
 
@@ -144 +146 @@
      * @since 5.0.0
      *
+     * @global WP_Post $post Global post object.
+     *
      * @param WP_REST_Request $request Full details about the request.
      * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -152 +156 @@
         $post_id = isset( $request['post_id'] ) ? (int) $request['post_id'] : 0;
 
-        if ( 0 < $post_id ) {
+        if ( $post_id > 0 ) {
             $post = get_post( $post_id );
 

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

@@ -505 +505 @@
      * @since 4.7.0
      *
+     * @global array $wp_rest_additional_fields Holds registered fields, organized by 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.
+     * @return array Registered additional fields (if any), empty array if none or if the object type
+     *               could not be inferred.
      */
     protected function get_additional_fields( $object_type = null ) {
+        global $wp_rest_additional_fields;
 
         if ( ! $object_type ) {
@@ -518 +521 @@
             return array();
         }
-
-        global $wp_rest_additional_fields;
 
         if ( ! $wp_rest_additional_fields || ! isset( $wp_rest_additional_fields[ $object_type ] ) ) {

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

@@ -266 +266 @@
      * @since 5.5.0
      *
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
+     *
      * @param WP_REST_Request $request Full details about the request.
      * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
      */
     public function create_item( $request ) {
+        global $wp_filesystem;
+
         require_once ABSPATH . 'wp-admin/includes/file.php';
         require_once ABSPATH . 'wp-admin/includes/plugin.php';
@@ -330 +334 @@
 
         if ( is_null( $result ) ) {
-            global $wp_filesystem;
             // Pass through the error from WP_Filesystem if one was raised.
-            if ( $wp_filesystem instanceof WP_Filesystem_Base && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
-                return new WP_Error( 'unable_to_connect_to_filesystem', $wp_filesystem->errors->get_error_message(), array( 'status' => 500 ) );
-            }
-
-            return new WP_Error( 'unable_to_connect_to_filesystem', __( 'Unable to connect to the filesystem. Please confirm your credentials.' ), array( 'status' => 500 ) );
+            if ( $wp_filesystem instanceof WP_Filesystem_Base
+                && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors()
+            ) {
+                return new WP_Error(
+                    'unable_to_connect_to_filesystem',
+                    $wp_filesystem->errors->get_error_message(),
+                    array( 'status' => 500 )
+                );
+            }
+
+            return new WP_Error(
+                'unable_to_connect_to_filesystem',
+                __( 'Unable to connect to the filesystem. Please confirm your credentials.' ),
+                array( 'status' => 500 )
+            );
         }
 
@@ -342 +355 @@
 
         if ( ! $file ) {
-            return new WP_Error( 'unable_to_determine_installed_plugin', __( 'Unable to determine what plugin was installed.' ), array( 'status' => 500 ) );
+            return new WP_Error(
+                'unable_to_determine_installed_plugin',
+                __( 'Unable to determine what plugin was installed.' ),
+                array( 'status' => 500 )
+            );
         }
 

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

@@ -1174 +1174 @@
      * @since 4.7.0
      *
+     * @global WP_Roles $wp_roles WordPress role management object.
+     *
      * @param int   $user_id User ID.
      * @param array $roles   New user roles.