mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-03-20 12:00:03 +01:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Docs: Update description for retrieve_widgets() per the documentation standards.

Browse Source 
Follow-up to [51842].

See #53811.

git-svn-id: https://develop.svn.wordpress.org/trunk@51849 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2021-09-22 14:09:19 +00:00
parent d05ecf236f
commit cb5e2611a6
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/wp-includes/widgets.php
View File

@ -1255,15 +1255,17 @@ function _wp_sidebars_changed() {
}
/**
* Validates and remaps any "orphaned" widgets to wp_inactive_sidgets sidebar, and saves the widget settings.
* This has to run at least on each theme change.
* Validates and remaps any "orphaned" widgets to wp_inactive_widgets sidebar,
* and saves the widget settings. This has to run at least on each theme change.
*
* For example, let's say theme A has a "footer" sidebar, and theme B doesn't have one.
* After switching from theme A to theme B, all the widgets previously assigned to the footer would be inaccessible.
* This function detects this scenario, and moves all the widgets previously assigned to the footer under wp_inactive_widgets.
* After switching from theme A to theme B, all the widgets previously assigned
* to the footer would be inaccessible. This function detects this scenario, and
* moves all the widgets previously assigned to the footer under wp_inactive_widgets.
*
* Despite the word "retrieve" in the name, this function actually updates the database and the global $sidebars_widgets.
* For that reason it should not be run from the front end unless the param value is 'customize' (to bypass the database write).
* Despite the word "retrieve" in the name, this function actually updates the database
* and the global `$sidebars_widgets`. For that reason it should not be run on front end,
* unless the `$theme_changed` value is 'customize' (to bypass the database write).
*
* @since 2.8.0
*