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

Timestamp:

10/22/2025 03:02:29 PM (6 months ago)

Author:

gziolo

Message:

Abilities API: Normalize input from schema

Without this patch REST API would require a weird empty ?input field for optional input given how the current controller works with input schema when it defines the expected shape. This patch normalizes the input for the ability, applying the default value from the input schema when needed.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10395.

Follow-up [61032], [61045].

Props gziolo, jorgefilipecosta, mukesh27.
Fixes #64139.

File:

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

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

@@ -402 +402 @@
 
     /**
+     * Normalizes the input for the ability, applying the default value from the input schema when needed.
+     *
+     * When no input is provided and the input schema is defined with a top-level `default` key, this method returns
+     * the value of that key. If the input schema does not define a `default`, or if the input schema is empty,
+     * this method returns null. If input is provided, it is returned as-is.
+     *
+     * @since 6.9.0
+     *
+     * @param mixed $input Optional. The raw input provided for the ability. Default `null`.
+     * @return mixed The same input, or the default from schema, or `null` if default not set.
+     */
+    public function normalize_input( $input = null ) {
+        if ( null !== $input ) {
+            return $input;
+        }
+
+        $input_schema = $this->get_input_schema();
+        if ( ! empty( $input_schema ) && array_key_exists( 'default', $input_schema ) ) {
+            return $input_schema['default'];
+        }
+
+        return null;
+    }
+
+    /**
      * Validates input data against the input schema.
      *
@@ -537 +562 @@
      */
     public function execute( $input = null ) {
+        $input    = $this->normalize_input( $input );
         $is_valid = $this->validate_input( $input );
         if ( is_wp_error( $is_valid ) ) {