sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve documentation for is_active_sidebar().

Browse Source 
The function determines whether the sidebar contains widgets, not that it is loaded on the page.

Props SUM1.
Fixes #50347.

git-svn-id: https://develop.svn.wordpress.org/trunk@47935 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-06-09 15:29:57 +00:00
parent 16c36e4d2e
commit df3bd5ecb0
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -900,11 +900,13 @@ function is_active_widget( $callback = false, $widget_id = false, $id_base = fal
* @global array $wp_registered_widgets * @global array $wp_registered_widgets
* @global array $wp_registered_sidebars Registered sidebars. * @global array $wp_registered_sidebars Registered sidebars.
* *
* @return bool True, if using widgets. False, if not using widgets. * @return bool True if using widgets, false otherwise.
*/ */
function is_dynamic_sidebar() { function is_dynamic_sidebar() {
global $wp_registered_widgets, $wp_registered_sidebars; global $wp_registered_widgets, $wp_registered_sidebars;
$sidebars_widgets = get_option( 'sidebars_widgets' ); $sidebars_widgets = get_option( 'sidebars_widgets' );
foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) { foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
if ( ! empty( $sidebars_widgets[ $index ] ) ) { if ( ! empty( $sidebars_widgets[ $index ] ) ) {
foreach ( (array) $sidebars_widgets[ $index ] as $widget ) { foreach ( (array) $sidebars_widgets[ $index ] as $widget ) {
@ -914,11 +916,12 @@ function is_dynamic_sidebar() {
} }
} }
} }
return false; return false;
} }
/** /**
* Determines whether a sidebar is in use. * Determines whether a sidebar contains widgets.
* *
* For more information on this and similar theme functions, check out * For more information on this and similar theme functions, check out
* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
@ -927,7 +930,7 @@ function is_dynamic_sidebar() {
* @since 2.8.0 * @since 2.8.0
* *
* @param string|int $index Sidebar name, id or number to check. * @param string|int $index Sidebar name, id or number to check.
* @return bool true if the sidebar is in use, false otherwise. * @return bool True if the sidebar has widgets, false otherwise.
*/ */
function is_active_sidebar( $index ) { function is_active_sidebar( $index ) {
$index = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index ); $index = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index );