wp_get_sidebar( string $id ): array|null

Parameters

$idstring

The sidebar ID.

Return

array|null

The discovered sidebar, or null if it is not registered.

Uses · 1

• __()Retrieves the translation of $text.

Used by · 2

• WP_REST_Sidebars_Controller::get_sidebar()Retrieves the registered sidebar with the given id.
• WP_REST_Widgets_Controller::check_read_sidebar_permission()Checks if a sidebar can be read publicly.

Source

View on Trac ↗View on GitHub ↗

1064function wp_get_sidebar( $id ) {1065	global $wp_registered_sidebars;1066 1067	foreach ( (array) $wp_registered_sidebars as $sidebar ) {1068		if ( $sidebar['id'] === $id ) {1069			return $sidebar;1070		}1071	}1072 1073	if ( 'wp_inactive_widgets' === $id ) {1074		return array(1075			'id'   => 'wp_inactive_widgets',1076			'name' => __( 'Inactive widgets' ),1077		);1078	}1079 1080	return null;1081}

History

Introduced in 5.9.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.9.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.