Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: Improve documentation for `is_active_sidebar()`. 

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

Props SUM1.
Fixes #50347.
Built from https://develop.svn.wordpress.org/trunk@47935


git-svn-id: http://core.svn.wordpress.org/trunk@47708 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-06-09 15:31:09 +00:00
parent c681e37da7
commit c227ed2322
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.5-alpha-47934';
$wp_version = '5.5-alpha-47935';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

9
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_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() {
global $wp_registered_widgets, $wp_registered_sidebars;
$sidebars_widgets = get_option( 'sidebars_widgets' );
foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
if ( ! empty( $sidebars_widgets[ $index ] ) ) {
foreach ( (array) $sidebars_widgets[ $index ] as $widget ) {
@ -914,11 +916,12 @@ function is_dynamic_sidebar() {
}
}
}
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
* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
@ -927,7 +930,7 @@ function is_dynamic_sidebar() {
* @since 2.8.0
*
* @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 ) {
$index = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index );