WP_Ability::check_permissions( mixed $input = null ): bool|WP_Error

Checks whether the ability has the necessary permissions.

Description

Please note that input is not automatically validated against the input schema.
Use validate_input() method to validate input before calling this method if needed.

Parameters

$inputmixedoptional: The valid input data for permission checking. Default null.
Default:null

Return

bool|WP_Error Whether the ability has the necessary permission.

Source

public function check_permissions( $input = null ) {
	if ( ! is_callable( $this->permission_callback ) ) {
		return new WP_Error(
			'ability_invalid_permission_callback',
			/* translators: %s ability name. */
			sprintf( __( 'Ability "%s" does not have a valid permission callback.' ), esc_html( $this->name ) )
		);
	}

	return $this->invoke_callback( $this->permission_callback, $input );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Ability::invoke_callback()`wp-includes/abilities-api/class-wp-ability.php`	Invokes a callable, ensuring the input is passed through only if the input schema is defined.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
esc_html()`wp-includes/formatting.php`	Escaping for HTML blocks.
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Show 2 more Show less

Used by	Description
WP_Ability::execute()`wp-includes/abilities-api/class-wp-ability.php`	Executes the ability after input validation and running a permission check.

Changelog

Version	Description
6.9.0	Introduced.

User Contributed Notes

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