Changeset 51705 for trunk/src/wp-includes/widgets.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/widgets.php (modified) (2 diffs)

trunk/src/wp-includes/widgets.php

@@ -1252 +1252 @@
     }
 
-    retrieve_widgets( true );
-}
-
-/**
- * Look for "lost" widgets, this has to run at least on each theme change.
+    sync_registered_widgets( true );
+}
+
+/**
+ * Do not use, deprecated.
+ *
+ * Use sync_registered_widgets() instead.
  *
  * @since 2.8.0
+ * @deprecated 5.8.1 Use sync_registered_widgets()
+ * @see sync_registered_widgets()
+ *
+ * @param string|bool $theme_changed
+ * @return array
+ */
+function retrieve_widgets( $theme_changed = false ) {
+    return sync_registered_widgets( $theme_changed );
+}
+
+/**
+ * Looks for "lost" widgets and Updates widgets-to-sidebars allocation.
+ * This has to run at least on each theme change.
+ *
+ * @since 5.8.1
  *
  * @global array $wp_registered_sidebars Registered sidebars.
@@ -1268 +1285 @@
  * @return array Updated sidebars widgets.
  */
-function retrieve_widgets( $theme_changed = false ) {
+function sync_registered_widgets( $theme_changed = false ) {
     global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;