WP_REST_Widgets_Controller::check_read_sidebar_permission() – Method

WP_REST_Widgets_Controller::check_read_sidebar_permission( string $sidebar_id ): bool

Checks if a sidebar can be read publicly.

Parameters

$sidebar_idstringrequired: The sidebar ID.

Return

bool Whether the sidebar can be read.

Source

protected function check_read_sidebar_permission( $sidebar_id ) {
	$sidebar = wp_get_sidebar( $sidebar_id );

	return ! empty( $sidebar['show_in_rest'] );
}

View all references View on Trac View on GitHub

Uses	Description
wp_get_sidebar()`wp-includes/widgets.php`	Retrieves the registered sidebar with the given ID.

Used by	Description
WP_REST_Widgets_Controller::get_items_permissions_check()`wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php`	Checks if a given request has access to get widgets.
WP_REST_Widgets_Controller::get_items()`wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php`	Retrieves a collection of widgets.
WP_REST_Widgets_Controller::get_item_permissions_check()`wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php`	Checks if a given request has access to get a widget.

Changelog

Version	Description
5.9.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.