Changeset 51705 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Timestamp:

08/31/2021 07:57:20 PM (3 years ago)

Author:

hellofromTonya

Message:

Widgets: Rename and soft deprecate retrieve_widgets().

The original name retrieve_widgets() was unclear as it suggested it was a getter, i.e. getting the widgets. This function does more than get: finds orphaned widgets, assigns them to the inactive sidebar, and updates the database.

The new name is sync_registered_widgets() which better represents what happens when this function is invoked.

The original retrieve_widgets() function is soft deprecated to avoid unnecessary code churn downstream for developers that support more than the latest version of WordPress.

Follow-up to [18630].

Props zieladam, timothyblynjacobs, andraganescu, hellofromTonya.
See #53811.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php (modified) (6 diffs)

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

@@ -110 +110 @@
      */
     public function get_items( $request ) {
-        retrieve_widgets();
+        sync_registered_widgets();
 
         $prepared = array();
@@ -152 +152 @@
      */
     public function get_item( $request ) {
-        retrieve_widgets();
+        sync_registered_widgets();
 
         $widget_id  = $request['id'];
@@ -238 +238 @@
 
         /*
-         * retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
+         * sync_registered_widgets() contains logic to move "hidden" or "lost" widgets to the
          * wp_inactive_widgets sidebar based on the contents of the $sidebars_widgets global.
          *
@@ -249 +249 @@
         wp_get_sidebars_widgets();
 
-        retrieve_widgets();
+        sync_registered_widgets();
 
         $widget_id  = $request['id'];
@@ -314 +314 @@
 
         /*
-         * retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
+         * sync_registered_widgets() contains logic to move "hidden" or "lost" widgets to the
          * wp_inactive_widgets sidebar based on the contents of the $sidebars_widgets global.
          *
@@ -325 +325 @@
         wp_get_sidebars_widgets();
 
-        retrieve_widgets();
+        sync_registered_widgets();
 
         $widget_id  = $request['id'];