Changeset 49203 for trunk/src/wp-includes/widgets.php

Timestamp:

10/19/2020 03:38:11 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Widgets: Introduce before_sidebar and after_sidebar arguments for register_sidebar().

Props deepaklalwani, flixos90, christophherr, dgwyer, markoheijnen, morganestes, audrasjb.
Fixes #19709.

File:

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

trunk/src/wp-includes/widgets.php

@@ -220 +220 @@
  *
  * @since 2.2.0
+ * @since 5.6.0 Added the `before_sidebar` and `after_sidebar` arguments.
  *
  * @global array $wp_registered_sidebars Registered sidebars.
@@ -226 +227 @@
  *     Optional. Array or string of arguments for the sidebar being registered.
  *
- *     @type string $name          The name or title of the sidebar displayed in the Widgets
- *                                 interface. Default 'Sidebar $instance'.
- *     @type string $id            The unique identifier by which the sidebar will be called.
- *                                 Default 'sidebar-$instance'.
- *     @type string $description   Description of the sidebar, displayed in the Widgets interface.
- *                                 Default empty string.
- *     @type string $class         Extra CSS class to assign to the sidebar in the Widgets interface.
- *                                 Default empty.
- *     @type string $before_widget HTML content to prepend to each widget's HTML output when
- *                                 assigned to this sidebar. Default is an opening list item element.
- *     @type string $after_widget  HTML content to append to each widget's HTML output when
- *                                 assigned to this sidebar. Default is a closing list item element.
- *     @type string $before_title  HTML content to prepend to the sidebar title when displayed.
- *                                 Default is an opening h2 element.
- *     @type string $after_title   HTML content to append to the sidebar title when displayed.
- *                                 Default is a closing h2 element.
+ *     @type string $name           The name or title of the sidebar displayed in the Widgets
+ *                                  interface. Default 'Sidebar $instance'.
+ *     @type string $id             The unique identifier by which the sidebar will be called.
+ *                                  Default 'sidebar-$instance'.
+ *     @type string $description    Description of the sidebar, displayed in the Widgets interface.
+ *                                  Default empty string.
+ *     @type string $class          Extra CSS class to assign to the sidebar in the Widgets interface.
+ *                                  Default empty.
+ *     @type string $before_widget  HTML content to prepend to each widget's HTML output when
+ *                                  assigned to this sidebar. Default is an opening list item element.
+ *     @type string $after_widget   HTML content to append to each widget's HTML output when
+ *                                  assigned to this sidebar. Default is a closing list item element.
+ *     @type string $before_title   HTML content to prepend to the sidebar title when displayed.
+ *                                  Default is an opening h2 element.
+ *     @type string $after_title    HTML content to append to the sidebar title when displayed.
+ *                                  Default is a closing h2 element.
+ *     @type string $before_sidebar HTML content to prepend to the sidebar when displayed.
+ *                                  Outputs after the {@see 'dynamic_sidebar_before'} action.
+ *                                  Default empty string.
+ *     @type string $after_sidebar  HTML content to append to the sidebar when displayed.
+ *                                  Outputs before the {@see 'dynamic_sidebar_after'} action.
+ *                                  Default empty string.
  * }
  * @return string Sidebar ID added to $wp_registered_sidebars global.
@@ -254 +261 @@
     $defaults = array(
         /* translators: %d: Sidebar number. */
-        'name'          => sprintf( __( 'Sidebar %d' ), $i ),
-        'id'            => "sidebar-$i",
-        'description'   => '',
-        'class'         => '',
-        'before_widget' => '<li id="%1$s" class="widget %2$s">',
-        'after_widget'  => "</li>\n",
-        'before_title'  => '<h2 class="widgettitle">',
-        'after_title'   => "</h2>\n",
+        'name'           => sprintf( __( 'Sidebar %d' ), $i ),
+        'id'             => "sidebar-$i",
+        'description'    => '',
+        'class'          => '',
+        'before_widget'  => '<li id="%1$s" class="widget %2$s">',
+        'after_widget'   => "</li>\n",
+        'before_title'   => '<h2 class="widgettitle">',
+        'after_title'    => "</h2>\n",
+        'before_sidebar' => '',
+        'after_sidebar'  => '',
     );
 
@@ -692 +701 @@
     }
 
+    $sidebar = $wp_registered_sidebars[ $index ];
+
+    $sidebar['before_sidebar'] = sprintf( $sidebar['before_sidebar'], $sidebar['id'], $sidebar['class'] );
+
     /**
      * Fires before widgets are rendered in a dynamic sidebar.
@@ -705 +718 @@
      */
     do_action( 'dynamic_sidebar_before', $index, true );
-    $sidebar = $wp_registered_sidebars[ $index ];
+
+    if ( ! empty( $sidebar['before_sidebar'] ) ) {
+        echo $sidebar['before_sidebar'];
+    }
 
     $did_one = false;
@@ -808 +824 @@
     }
 
+    if ( ! empty( $sidebar['after_sidebar'] ) ) {
+        echo $sidebar['after_sidebar'];
+    }
+
     /**
      * Fires after widgets are rendered in a dynamic sidebar.