Changeset 32110

Timestamp:

04/11/2015 09:33:14 PM (9 years ago)

Author:

markjaquith

Message:

Tell developers how to correctly silence register_sidebar() notices.

• If we just tell them they they should set an id parameter, they might set an arbitrary one on an existing (i.e. not in-development) theme, causing widgets to be lost.
• This way, we tell them to set it to the auto-generated id that the sidebar already has.
• Widget content is not lost, and now their sidebar has a concrete handle.

fixes #31675

File:

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

trunk/src/wp-includes/widgets.php

@@ -804 +804 @@
     $i = count($wp_registered_sidebars) + 1;
 
-    if ( empty( $args['id'] ) ) {
-        /* translators: %s: the id argument */
-        _doing_it_wrong( __FUNCTION__, sprintf( __( 'You should set %s in the arguments array.' ), '<code>id</code>' ), '4.2.0' );
-    }
+    $id_is_empty = empty( $args['id'] );
 
     $defaults = array(
@@ -821 +818 @@
 
     $sidebar = wp_parse_args( $args, $defaults );
+
+    if ( $id_is_empty ) {
+        /* translators: %1$s: the id argument */
+        _doing_it_wrong( __FUNCTION__, sprintf( __( 'No %1$s was set in the arguments array for the "%2$s" sidebar. Defaulting to "%3$s". Manually set the %1$s to  "%3$s" to silence this notice and keep existing sidebar content.' ), '<code>id</code>', $sidebar['name'], $sidebar['id'] ), '4.2.0' );
+    }
 
     $wp_registered_sidebars[$sidebar['id']] = $sidebar;