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

Description

Parameters

$inputmixedoptional

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

Return

bool|WP_Error

Whether the ability has the necessary permission.

Uses · 4

• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• WP_Error::__construct()Initializes the error.
• WP_Ability::invoke_callback()Invokes a callable, ensuring the input is passed through only if the input schema is defined.

Used by · 1

• WP_Ability::execute()Executes the ability after input validation and running a permission check.

Source

View on Trac ↗View on GitHub ↗

527	public function check_permissions( $input = null ) {528		if ( ! is_callable( $this->permission_callback ) ) {529			return new WP_Error(530				'ability_invalid_permission_callback',531				/* translators: %s ability name. */532				sprintf( __( 'Ability "%s" does not have a valid permission callback.' ), esc_html( $this->name ) )533			);534		}535 536		return $this->invoke_callback( $this->permission_callback, $input );537	}

History

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/abilities-api/class-wp-ability.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.