dynamic_sidebar( int|string $index = 1 ): bool

Description

Parameters

$indexint|stringoptional

Index, name or ID of dynamic sidebar. Default 1.Default: 1

Return

bool

True, if widget sidebar was found and called. False if not found or not called.

Hooks fired · 8

8 hooks fire while dynamic_sidebar() runs, in this order:

1. 1
   do_action( dynamic_sidebar_before )actionline 715 (+18 into the body)

   Fires before widgets are rendered in a dynamic sidebar.

2. 2
   do_action( dynamic_sidebar_after )actionline 717 (+20 into the body)

   Fires after widgets are rendered in a dynamic sidebar.

3. 3
   apply_filters( dynamic_sidebar_has_widgets )filterline 719 (+22 into the body)

   Filters whether a sidebar has widgets.

4. 4
   do_action( dynamic_sidebar_before )actionline 738 (+41 into the body)

   Fires before widgets are rendered in a dynamic sidebar.

5. 5
   apply_filters( dynamic_sidebar_params )filterline 813 (+116 into the body)

   Filters the parameters passed to a widget's display callback.

6. 6
   do_action( dynamic_sidebar )actionline 842 (+145 into the body)

   Fires before a widget's display callback is called.

7. 7
   do_action( dynamic_sidebar_after )actionline 866 (+169 into the body)

   Fires after widgets are rendered in a dynamic sidebar.

8. 8
   apply_filters( dynamic_sidebar_has_widgets )filterline 880 (+183 into the body)

   Filters whether a sidebar has widgets.

Uses · 5

• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• wp_get_sidebars_widgets()Retrieve full list of sidebars and their widget instance IDs.
• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_admin()Determines whether the current request is for an administrative interface page.

Used by · 2

• WP_Customize_Widgets::render_widget_partial()Renders a specific widget using the supplied sidebar arguments.
• wp_list_widget_controls()Show the widgets and their settings for a sidebar.

Source

View on Trac ↗View on GitHub ↗

697function dynamic_sidebar( $index = 1 ) {698	global $wp_registered_sidebars, $wp_registered_widgets;699 700	if ( is_int( $index ) ) {701		$index = "sidebar-$index";702	} else {703		$index = sanitize_title( $index );704		foreach ( (array) $wp_registered_sidebars as $key => $value ) {705			if ( sanitize_title( $value['name'] ) === $index ) {706				$index = $key;707				break;708			}709		}710	}711 712	$sidebars_widgets = wp_get_sidebars_widgets();713	if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {714		/** This action is documented in wp-includes/widget.php */715		do_action( 'dynamic_sidebar_before', $index, false );716		/** This action is documented in wp-includes/widget.php */717		do_action( 'dynamic_sidebar_after', $index, false );718		/** This filter is documented in wp-includes/widget.php */719		return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );720	}721 722	$sidebar = $wp_registered_sidebars[ $index ];723 724	$sidebar['before_sidebar'] = sprintf( $sidebar['before_sidebar'], $sidebar['id'], $sidebar['class'] );725 726	/**727	 * Fires before widgets are rendered in a dynamic sidebar.728	 *729	 * Note: The action also fires for empty sidebars, and on both the front end730	 * and back end, including the Inactive Widgets sidebar on the Widgets screen.731	 *732	 * @since 3.9.0733	 *734	 * @param int|string $index       Index, name, or ID of the dynamic sidebar.735	 * @param bool       $has_widgets Whether the sidebar is populated with widgets.736	 *                                Default true.737	 */738	do_action( 'dynamic_sidebar_before', $index, true );739 740	if ( ! is_admin() && ! empty( $sidebar['before_sidebar'] ) ) {741		echo $sidebar['before_sidebar'];742	}743 744	$did_one = false;745	foreach ( (array) $sidebars_widgets[ $index ] as $id ) {746 747		if ( ! isset( $wp_registered_widgets[ $id ] ) ) {748			continue;749		}750 751		$params = array_merge(752			array(753				array_merge(754					$sidebar,755					array(756						'widget_id'   => $id,757						'widget_name' => $wp_registered_widgets[ $id ]['name'],758					)759				),760			),761			(array) $wp_registered_widgets[ $id ]['params']762		);763 764		// Substitute HTML `id` and `class` attributes into `before_widget`.765		$classname_ = '';766		foreach ( (array) $wp_registered_widgets[ $id ]['classname'] as $cn ) {767			if ( is_string( $cn ) ) {768				$classname_ .= '_' . $cn;769			} elseif ( is_object( $cn ) ) {770				$classname_ .= '_' . get_class( $cn );771			}772		}773		$classname_ = ltrim( $classname_, '_' );774 775		$params[0]['before_widget'] = sprintf(776			$params[0]['before_widget'],

History

Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/widgets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.