WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Widget_Types_Controller::check_read_permission()

WP_REST_Widget_Types_Controller::check_read_permission(): true|WP_Error

In this article

Back to top

Checks whether the user can read widget types.

Return

true|WP_Error True if the widget type is visible, WP_Error otherwise.

Source

protected function check_read_permission() {
	if ( ! current_user_can( 'edit_theme_options' ) ) {
		return new WP_Error(
			'rest_cannot_manage_widgets',
			__( 'Sorry, you are not allowed to manage widgets on this site.' ),
			array(
				'status' => rest_authorization_required_code(),
			)
		);
	}

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
rest_authorization_required_code()wp-includes/rest-api.php

Returns a contextual HTTP error code for authorization failure.

current_user_can()wp-includes/capabilities.php

Returns whether the current user has the specified capability.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less
Used byDescription
WP_REST_Widget_Types_Controller::get_items_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

Checks whether a given request has permission to read widget types.

WP_REST_Widget_Types_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

Checks if a given request has access to read a widget type.

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

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