WP_Ability::do_execute( mixed $input = null ): mixed|WP_Error
- Since
- 6.9.0, 7.1.0
- Source
wp-includes/abilities-api/class-wp-ability.php:671
Description
The 'wp_ability_execute_result' filter fires before this method returns, allowing plugins to transform the result produced by the registered execute_callback.
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
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::do_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
- Scaling
- Constant
- Instructions
- 24–31
- Plugin surface
- 1 hook
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.
Third-party callbacks on 'wp_ability_execute_result' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach query, option, cache, serialize 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Ability::do_execute() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_callable() | 24 | is_callable(), ->invoke_callback(), apply_filters() |
!is_callable() | 31 | is_callable(), __(), sprintf(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 38 instructions, 24–31 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while WP_Ability::do_execute() runs, in this order:
- apply_filters( wp_ability_execute_result )filterline 701 (+30 into the body)
Filters the result returned by an ability's execute callback.
Uses · 4
- __()Retrieves the translation of $text.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- 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 code
protected function do_execute( $input = null ) { if ( ! is_callable( $this->execute_callback ) ) { $result = new WP_Error( 'ability_invalid_execute_callback', /* translators: %s ability name. */ sprintf( __( 'Ability "%s" does not have a valid execute callback.' ), $this->name ) ); } else { $result = $this->invoke_callback( $this->execute_callback, $input ); } /** * Filters the result returned by an ability's execute callback. * * Fires after the registered execute callback runs. Plugins can use this to transform the * result — response formatting, stripping internal metadata, content safety filtering, * response enrichment, or recovering from a failure by returning a successful value. * * The filter receives whatever the registered callback produced, including a `WP_Error` * if execution failed. Filters may pass the `WP_Error` through unchanged, override it with * a recovered result, or convert a successful result into a `WP_Error`. * * @since 7.1.0 * * @param mixed $result The result returned by the registered `execute_callback`, * or a `WP_Error` if execution failed. * @param string $ability_name The name of the ability. * @param mixed $input The normalized input data. * @param WP_Ability $ability The ability instance. */ return apply_filters( 'wp_ability_execute_result', $result, $this->name, $input, $this ); }Changelog
Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.
Signature, return type and hooks compared across 3 parsed releases.
wp_ability_execute_result filter.from the docblockAbout 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.