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

Parameters

$requestWP_REST_Request

Full details about the request.

Return

true|WP_Error

Uses · 4

• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
• WP_Error::__construct()Initializes the error.

Used by · 6

• WP_REST_Widgets_Controller::create_item_permissions_check()Checks if a given request has access to create widgets.
• WP_REST_Widgets_Controller::delete_item_permissions_check()Checks if a given request has access to delete widgets.
• WP_REST_Widgets_Controller::get_item_permissions_check()Checks if a given request has access to get a widget.
• WP_REST_Widgets_Controller::get_items()Retrieves a collection of widgets.
• WP_REST_Widgets_Controller::get_items_permissions_check()Checks if a given request has access to get widgets.
• WP_REST_Widgets_Controller::update_item_permissions_check()Checks if a given request has access to update widgets.

Source

View on Trac ↗View on GitHub ↗

481	protected function permissions_check( $request ) {482		if ( ! current_user_can( 'edit_theme_options' ) ) {483			return new WP_Error(484				'rest_cannot_manage_widgets',485				__( 'Sorry, you are not allowed to manage widgets on this site.' ),486				array(487					'status' => rest_authorization_required_code(),488				)489			);490		}491 492		return true;493	}

History

Introduced in 5.8.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/rest-api/endpoints/class-wp-rest-widgets-controller.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.