Changeset 51310 for branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Timestamp:

07/02/2021 06:51:12 PM (3 years ago)

Author:

desrosj

Message:

Docs: Document the globals used in WP_REST_Widget_Types_Controller and WP_REST_Widgets_Controller.

Follow-up to [50995].

Props SergeyBiryukov.
Merges [51279] to the 5.8 branch.
See #52628, #53461.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php (modified) (5 diffs)

branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

@@ -229 +229 @@
      * @since 5.8.0
      *
+     * @global WP_Widget_Factory $wp_widget_factory
+     *
      * @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.
@@ -290 +292 @@
      * @since 5.8.0
      *
+     * @global WP_Widget_Factory $wp_widget_factory
      * @global array             $wp_registered_widget_updates The registered widget update functions.
-     * @global WP_Widget_Factory $wp_widget_factory
      *
      * @param WP_REST_Request $request Full details about the request.
@@ -297 +299 @@
      */
     public function delete_item( $request ) {
-        global $wp_registered_widget_updates, $wp_widget_factory;
+        global $wp_widget_factory, $wp_registered_widget_updates;
 
         retrieve_widgets();
@@ -417 +419 @@
      *
      * @since 5.8.0
+     *
+     * @global WP_Widget_Factory $wp_widget_factory
+     * @global array             $wp_registered_widget_updates The registered widget update functions.
      *
      * @param WP_REST_Request $request    Full details about the request.
@@ -561 +566 @@
      * @since 5.8.0
      *
-     * @global array $wp_registered_sidebars        The registered sidebars.
-     * @global array $wp_registered_widgets         The registered widgets.
-     * @global array $wp_registered_widget_controls The registered widget controls.
+     * @global WP_Widget_Factory $wp_widget_factory
+     * @global array             $wp_registered_widgets The registered widgets.
      *
      * @param array           $item    An array containing a widget_id and sidebar_id.