WP_REST_Widgets_Controller::get_items_permissions_check( WP_REST_Request $request ): true|WP_Error

Checks if a given request has access to get widgets.

Contents

Parameters

$request WP_REST_Request Required
Full details about the request.

Top ↑

Return

true|WP_Error True if the request has read access, WP_Error object otherwise.

Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php. View all references 

public function get_items_permissions_check( $request ) {
	$this->retrieve_widgets();
	if ( isset( $request['sidebar'] ) && $this->check_read_sidebar_permission( $request['sidebar'] ) ) {
		return true;
	}

	foreach ( wp_get_sidebars_widgets() as $sidebar_id => $widget_ids ) {
		if ( $this->check_read_sidebar_permission( $sidebar_id ) ) {
			return true;
		}
	}

	return $this->permissions_check( $request );
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
WP_REST_Widgets_Controller::retrieve_widgets() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Looks for “lost” widgets once per request.
WP_REST_Widgets_Controller::check_read_sidebar_permission() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Checks if a sidebar can be read publicly.
WP_REST_Widgets_Controller::permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Performs a permissions check for managing widgets.
wp_get_sidebars_widgets() wp-includes/widgets.php

Retrieve full list of sidebars and their widget instance IDs.

Top ↑

Changelog

Changelog
Version Description
5.8.0 Introduced.

Top ↑

User Contributed Notes

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