WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Icons_Controller::get_items_permissions_check()

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

In this article

Back to top

Checks whether a given request has permission to read icons.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

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

Source

public function get_items_permissions_check(
	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	$request
) {
	if ( current_user_can( 'edit_posts' ) ) {
		return true;
	}

	foreach ( get_post_types( array( 'show_in_rest' => true ), 'objects' ) as $post_type ) {
		if ( current_user_can( $post_type->cap->edit_posts ) ) {
			return true;
		}
	}

	return new WP_Error(
		'rest_cannot_view',
		__( 'Sorry, you are not allowed to view the registered icons.' ),
		array( 'status' => rest_authorization_required_code() )
	);
}

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-includes/l10n.php

Retrieves the translation of $text.

get_post_types()wp-includes/post.php

Gets a list of all registered post type objects.

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

Initializes the error.

Show 3 moreShow less
Used byDescription
WP_REST_Icons_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php

Checks if a given request has access to read a specific icon.

User Contributed Notes

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