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

Description

Compatibility

Present in 3 of the 5 tracked releases, added in 7.1.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

27–84

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

Plugin surface

4 hooks

Third-party callbacks on 'wp_ability_invoked', 'wp_pre_execute_ability', 'wp_before_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 · 8 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 · 4

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

1. 1
   do_action( wp_ability_invoked )actionline 783 (+14 into the body)

   Fires when an ability is invoked, before any processing takes place.

2. 2
   apply_filters( wp_pre_execute_ability )filterline 809 (+40 into the body)

   Filters whether to short-circuit ability execution.

3. 3
   do_action( wp_before_execute_ability )actionline 852 (+83 into the body)

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

4. 4
   do_action( wp_after_execute_ability )actionline 875 (+106 into the body)

   Fires immediately after an ability finished executing.

Uses · 13

• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• 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.
• WP_Filter_Sentinel::__construct()
• 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.

Source code

View on Trac ↗View on GitHub ↗

769	public function execute( $input = null ) {770		/**771		 * Fires when an ability is invoked, before any processing takes place.772		 *773		 * This action fires for every call regardless of outcome (validation failure,774		 * permission denial, short-circuit, or successful execution), and before input775		 * normalization so the raw input is captured as-is.776		 *777		 * @since 7.1.0778		 *779		 * @param string     $ability_name The name of the ability.780		 * @param mixed      $input        The raw input data for the ability, before normalization.781		 * @param WP_Ability $ability      The ability instance.782		 */783		do_action( 'wp_ability_invoked', $this->name, $input, $this );784 785		$pre_execute_sentinel = new WP_Filter_Sentinel();786 787		/**788		 * Filters whether to short-circuit ability execution.789		 *790		 * Returning a value other than the received default bypasses the rest of `execute()` —791		 * input normalization, input validation, permission checks, the registered execute callback,792		 * output validation, and the surrounding actions — and the value is returned to the caller793		 * as-is. Useful for cached responses, rate limiting, maintenance mode, and test mocking.794		 *795		 * To continue with normal execution, return `$pre` unchanged. This preserves any value796		 * (including `null`, `false`, or arbitrary objects) as a valid short-circuit result.797		 *798		 * Because validation is bypassed, callers that short-circuit are responsible for the799		 * integrity of any value they consume from `$input`.800		 *801		 * @since 7.1.0802		 *803		 * @param mixed      $pre          The pre-computed result. Return this value unchanged to continue execution.804		 *                                 Default `WP_Filter_Sentinel` instance unique to this invocation.805		 * @param string     $ability_name The name of the ability.806		 * @param mixed      $input        The raw input passed to `execute()`.807		 * @param WP_Ability $ability      The ability instance.808		 */809		$pre = apply_filters( 'wp_pre_execute_ability', $pre_execute_sentinel, $this->name, $input, $this );810		if ( $pre !== $pre_execute_sentinel ) {811			return $pre;812		}813 814		$input = $this->normalize_input( $input );815		if ( is_wp_error( $input ) ) {816			return $input;817		}818 819		$is_valid = $this->validate_input( $input );820		if ( is_wp_error( $is_valid ) ) {821			return $is_valid;822		}823 824		$has_permissions = $this->check_permissions( $input );825		if ( true !== $has_permissions ) {826			if ( is_wp_error( $has_permissions ) ) {827				// Don't leak the permission check error to someone without the correct perms.828				_doing_it_wrong(829					__METHOD__,830					esc_html( $has_permissions->get_error_message() ),831					'6.9.0'832				);833			}834 835			return new WP_Error(836				'ability_invalid_permissions',837				/* translators: %s ability name. */838				sprintf( __( 'Ability "%s" does not have necessary permission.' ), $this->name )839			);840		}841 842		/**843		 * Fires before an ability gets executed, after input validation and permissions check.844		 *845		 * @since 6.9.0846		 * @since 7.1.0 Added the `$ability` parameter.847		 *848		 * @param string     $ability_name The name of the ability.

Changelog

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 7.1.0 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.