Action hook 'dynamic_sidebar_before'
in WP Core File wp-includes/widgets.php at line 715
Description
Display dynamic sidebar. By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or 'name' parameter for its registered sidebars you can pass an ID or name as the $index parameter. Otherwise, you can pass in a numerical index to display the sidebar at that index.
Occurrences
| Filename |
Line Number |
| wp-includes/widgets.php |
715 |
| wp-includes/widgets.php |
738 |
Parameters
| Type |
Name |
Description |
| int|string |
$index |
Optional. Index, name or ID of dynamic sidebar. Default 1. |
PHP Doc
/**
* Display dynamic sidebar.
*
* By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
* 'name' parameter for its registered sidebars you can pass an ID or name as the $index parameter.
* Otherwise, you can pass in a numerical index to display the sidebar at that index.
*
* @since 2.2.0
*
* @global array $wp_registered_sidebars The registered sidebars.
* @global array $wp_registered_widgets The registered widgets.
*
* @param int|string $index Optional. Index, name or ID of dynamic sidebar. Default 1.
* @return bool True, if widget sidebar was found and called. False if not found or not called.
*/