Changeset 62418 for trunk/src/wp-includes/abilities-api/class-wp-ability.php

Timestamp:

05/26/2026 08:14:49 AM (4 months ago)

Author:

gziolo

Message:

Abilities API: Add wp_ability_invoked action

Introduces a new wp_ability_invoked action that fires at the start of WP_Ability::execute(), before input normalization, validation, or permission checks. This gives observers a reliable entry point for every invocation regardless of outcome (short-circuit, validation failure, permission denial, or successful execution).

Also extends the existing wp_before_execute_ability and wp_after_execute_ability actions with a new $ability parameter exposing the WP_Ability instance.

Follow-up for #64989.

Props sukhendu2002, peterwilsoncc, gziolo.
Fixes #65248.

File:

• trunk/src/wp-includes/abilities-api/class-wp-ability.php (modified) (4 diffs)

trunk/src/wp-includes/abilities-api/class-wp-ability.php

@@ -726 +726 @@
          *
          * @since 6.9.0
+         * @since 7.1.0 Added the `wp_ability_invoked` action.
          * @since 7.1.0 Added the `wp_pre_execute_ability` filter.
          *
@@ -732 +733 @@
          */
         public function execute( $input = null ) {
+                /**
+                 * Fires when an ability is invoked, before any processing takes place.
+                 *
+                 * This action fires for every call regardless of outcome (validation failure,
+                 * permission denial, short-circuit, or successful execution), and before input
+                 * normalization so the raw input is captured as-is.
+                 *
+                 * @since 7.1.0
+                 *
+                 * @param string     $ability_name The name of the ability.
+                 * @param mixed      $input        The raw input data for the ability, before normalization.
+                 * @param WP_Ability $ability      The ability instance.
+                 */
+                do_action( 'wp_ability_invoked', $this->name, $input, $this );
+
                 /**
                  * Filters whether to short-circuit ability execution.
@@ -792 +808 @@
                  *
                  * @since 6.9.0
-                 *
-                 * @param string $ability_name The name of the ability.
-                 * @param mixed  $input        The input data for the ability.
-                 */
-                do_action( 'wp_before_execute_ability', $this->name, $input );
+                 * @since 7.1.0 Added the `$ability` parameter.
+                 *
+                 * @param string     $ability_name The name of the ability.
+                 * @param mixed      $input        The input data for the ability.
+                 * @param WP_Ability $ability      The ability instance.
+                 */
+                do_action( 'wp_before_execute_ability', $this->name, $input, $this );
 
                 $result = $this->do_execute( $input );
@@ -812 +830 @@
                  *
                  * @since 6.9.0
-                 *
-                 * @param string $ability_name The name of the ability.
-                 * @param mixed  $input        The input data for the ability.
-                 * @param mixed  $result       The result of the ability execution.
-                 */
-                do_action( 'wp_after_execute_ability', $this->name, $input, $result );
+                 * @since 7.1.0 Added the `$ability` parameter.
+                 *
+                 * @param string     $ability_name The name of the ability.
+                 * @param mixed      $input        The input data for the ability.
+                 * @param mixed      $result       The result of the ability execution.
+                 * @param WP_Ability $ability      The ability instance.
+                 */
+                do_action( 'wp_after_execute_ability', $this->name, $input, $result, $this );
 
                 return $result;