Changeset 51705 for trunk/src/wp-includes/theme.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/theme.php (modified) (1 diff)

trunk/src/wp-includes/theme.php

@@ -806 +806 @@
     } else {
         /*
-         * Since retrieve_widgets() is called when initializing a theme in the Customizer,
+         * Since sync_registered_widgets() is called when initializing a theme in the Customizer,
          * we need to remove the theme mods to avoid overwriting changes made via
          * the Customizer when accessing wp-admin/widgets.php.