On this page
WP_REST_Widgets_Controller::check_read_sidebar_permission( string $sidebar_id ): bool
Checks if a sidebar can be read publicly.
Parameters
$sidebar_idstring Required-
The sidebar ID.
Return
bool Whether the sidebar can be read.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php. View all references
protected function check_read_sidebar_permission( $sidebar_id ) {
$sidebar = wp_get_sidebar( $sidebar_id );
return ! empty( $sidebar['show_in_rest'] );
}
Related
Uses
| Uses | Description |
|---|---|
| wp_get_sidebar() wp-includes/widgets.php | Retrieves the registered sidebar with the given ID. |
Used By
| 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. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_widgets_controller/check_read_sidebar_permission