Changeset 35102

Timestamp:

10/13/2015 01:32:27 AM (9 years ago)

Author:

wonderboymusic

Message:

Widgets: add a function, is_registered_sidebar() - helps us avoid touching the $wp_registered_sidebars global.

Props GaryJ, wonderboymusic.
Fixes #24878.

Location:

trunk/src

Files:

• wp-admin/widgets.php (modified) (2 diffs)
• wp-includes/class-wp-customize-widgets.php (modified) (5 diffs)
• wp-includes/widget-functions.php (modified) (2 diffs)

trunk/src/wp-admin/widgets.php

@@ -90 +90 @@
         continue;
 
-    if ( !isset( $wp_registered_sidebars[ $sidebar_id ] ) ) {
+    if ( ! is_registered_sidebar( $sidebar_id ) ) {
         if ( ! empty( $widgets ) ) { // register the inactive_widgets area as sidebar
             register_sidebar(array(
@@ -156 +156 @@
         /**
          * Fires immediately after a widget has been marked for deletion.
-         * 
+         *
          * @since 4.4.0
          *

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -366 +366 @@
             }
 
-            $is_registered_sidebar = isset( $wp_registered_sidebars[ $sidebar_id ] );
+            $is_registered_sidebar = is_registered_sidebar( $sidebar_id );
             $is_inactive_widgets   = ( 'wp_inactive_widgets' === $sidebar_id );
             $is_active_sidebar     = ( $is_registered_sidebar && ! $is_inactive_widgets );
@@ -1103 +1103 @@
      * @access public
      *
-     * @global array $wp_registered_sidebars
-     *
      * @param bool   $is_active  Whether the sidebar is active.
      * @param string $sidebar_id Sidebar ID.
@@ -1110 +1108 @@
      */
     public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {
-        if ( isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ) ) {
+        if ( is_registered_sidebar( $sidebar_id ) ) {
             $this->rendered_sidebars[] = $sidebar_id;
         }
@@ -1131 +1129 @@
      * @access public
      *
-     * @global array $wp_registered_sidebars
-     *
      * @param bool   $has_widgets Whether the current sidebar has widgets.
      * @param string $sidebar_id  Sidebar ID.
@@ -1138 +1134 @@
      */
     public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) {
-        if ( isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ) ) {
+        if ( is_registered_sidebar( $sidebar_id ) ) {
             $this->rendered_sidebars[] = $sidebar_id;
         }

trunk/src/wp-includes/widget-functions.php

@@ -97 +97 @@
             $_args['id'] = $args['id'];
             $n = 2; // Start at -2 for conflicting custom ID's
-            while ( isset($wp_registered_sidebars[$_args['id']]) )
+            while ( is_registered_sidebar( $_args['id'] ) ) {
                 $_args['id'] = $args['id'] . '-' . $n++;
+            }
         } else {
-            $n = count($wp_registered_sidebars);
+            $n = count( $wp_registered_sidebars );
             do {
                 $_args['id'] = 'sidebar-' . ++$n;
-            } while ( isset($wp_registered_sidebars[$_args['id']]) );
+            } while ( is_registered_sidebar( $_args['id'] ) );
         }
         register_sidebar($_args);
@@ -204 +205 @@
 
     unset( $wp_registered_sidebars[ $name ] );
+}
+
+/**
+ * Checks if a sidebar is registered.
+ *
+ * @since 4.4.0
+ *
+ * @global array $wp_registered_sidebars Registered sidebars.
+ *
+ * @param string $name The ID of the sidebar when it was added.
+ *
+ * @return bool True if the sidebar is registered, false otherwise.
+ */
+function is_registered_sidebar( $name ) {
+    global $wp_registered_sidebars;
+    return isset( $wp_registered_sidebars[ $name ] );
 }