Changeset 47935

Timestamp:

06/09/2020 03:29:57 PM (5 years ago)

Author:

SergeyBiryukov

Message:

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.

File:

• trunk/src/wp-includes/widgets.php (modified) (3 diffs)

trunk/src/wp-includes/widgets.php

@@ -901 +901 @@
  * @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 ] ) ) {
@@ -915 +917 @@
         }
     }
+
     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
@@ -928 +931 @@
  *
  * @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 ) {