WP_Ability::execute( mixed $input = null ): mixed|WP_Error

Description

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$inputmixedoptional

The input data for the ability. Default null.Default: null

Return value

mixed|WP_Error

The result of the ability execution, or WP_Error on failure.

Performance profile

How much work a call to WP_Ability::execute() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–51

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 85.

Plugin surface

2 hooks

Third-party callbacks on 'wp_before_execute_ability', 'wp_after_execute_ability' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Ability::execute() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Ability::execute() runs, in this order:

1. 1
   do_action( wp_before_execute_ability )actionline 631 (+33 into the body)

   Fires before an ability gets executed, after input validation and permissions check.

2. 2
   do_action( wp_after_execute_ability )actionline 652 (+54 into the body)

   Fires immediately after an ability finished executing.

Uses · 11

• is_wp_error()Checks whether the given variable is a WordPress Error.
• _doing_it_wrong()Marks something as being incorrectly called.
• esc_html()Escaping for HTML blocks.
• __()Retrieves the translation of $text.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Ability::normalize_input()Normalizes the input for the ability, applying the default value from the input schema when needed.
• WP_Ability::validate_input()Validates input data against the input schema.
• WP_Ability::check_permissions()Checks whether the ability has the necessary permissions.
• WP_Error::__construct()Initializes the error.
• WP_Ability::do_execute()Executes the ability callback.
• WP_Ability::validate_output()Validates output data against the output schema.

Source code

View on Trac ↗View on GitHub ↗

598	public function execute( $input = null ) {599		$input    = $this->normalize_input( $input );600		$is_valid = $this->validate_input( $input );601		if ( is_wp_error( $is_valid ) ) {602			return $is_valid;603		}604 605		$has_permissions = $this->check_permissions( $input );606		if ( true !== $has_permissions ) {607			if ( is_wp_error( $has_permissions ) ) {608				// Don't leak the permission check error to someone without the correct perms.609				_doing_it_wrong(610					__METHOD__,611					esc_html( $has_permissions->get_error_message() ),612					'6.9.0'613				);614			}615 616			return new WP_Error(617				'ability_invalid_permissions',618				/* translators: %s ability name. */619				sprintf( __( 'Ability "%s" does not have necessary permission.' ), esc_html( $this->name ) )620			);621		}622 623		/**624		 * Fires before an ability gets executed, after input validation and permissions check.625		 *626		 * @since 6.9.0627		 *628		 * @param string $ability_name The name of the ability.629		 * @param mixed  $input        The input data for the ability.630		 */631		do_action( 'wp_before_execute_ability', $this->name, $input );632 633		$result = $this->do_execute( $input );634		if ( is_wp_error( $result ) ) {635			return $result;636		}637 638		$is_valid = $this->validate_output( $result );639		if ( is_wp_error( $is_valid ) ) {640			return $is_valid;641		}642 643		/**644		 * Fires immediately after an ability finished executing.645		 *646		 * @since 6.9.0647		 *648		 * @param string $ability_name The name of the ability.649		 * @param mixed  $input        The input data for the ability.650		 * @param mixed  $result       The result of the ability execution.651		 */652		do_action( 'wp_after_execute_ability', $this->name, $input, $result );653 654		return $result;655	}

Changelog

Introduced in 6.9.0. Unchanged from 6.9.10 through 7.1.3.

1. 6.9.10
2. 7.0.7
3. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.9.10 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.