Abilities API: Normalize input from schema

gziolo · gziolo · commit 7aa1b7ef5b0d · 2025-10-22T15:04:30.000Z
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 WordPress/wordpress-develop#10395. Follow-up [61032], [61045]. Props gziolo, jorgefilipecosta, mukesh27. Fixes #64139. Built from https://develop.svn.wordpress.org/trunk@61047 git-svn-id: http://core.svn.wordpress.org/trunk@60383 1a063a9b-81f0-0310-95a4-ce76da25c4cd
diff --git a/wp-includes/abilities-api/class-wp-ability.php b/wp-includes/abilities-api/class-wp-ability.php
@@ -400,6 +400,31 @@ public function get_meta_item( string $key, $default_value = null ) {
 		return array_key_exists( $key, $this->meta ) ? $this->meta[ $key ] : $default_value;
 	}
 
+	/**
+	 * 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.
 	 *
@@ -536,6 +561,7 @@ protected function validate_output( $output ) {
 	 * @return mixed|WP_Error The result of the ability execution, or WP_Error on failure.
 	 */
 	public function execute( $input = null ) {
+		$input    = $this->normalize_input( $input );
 		$is_valid = $this->validate_input( $input );
 		if ( is_wp_error( $is_valid ) ) {
 			return $is_valid;
diff --git a/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-categories-controller.php b/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-categories-controller.php
@@ -93,7 +93,7 @@ public function get_items( $request ) {
 		$offset   = ( $page - 1 ) * $per_page;
 
 		$total_categories = count( $categories );
-		$max_pages        = ceil( $total_categories / $per_page );
+		$max_pages        = (int) ceil( $total_categories / $per_page );
 
 		if ( $request->get_method() === 'HEAD' ) {
 			$response = new WP_REST_Response( array() );
diff --git a/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-list-controller.php b/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-list-controller.php
@@ -111,7 +111,7 @@ static function ( $ability ) use ( $category ) {
 		$offset   = ( $page - 1 ) * $per_page;
 
 		$total_abilities = count( $abilities );
-		$max_pages       = ceil( $total_abilities / $per_page );
+		$max_pages       = (int) ceil( $total_abilities / $per_page );
 
 		if ( $request->get_method() === 'HEAD' ) {
 			$response = new WP_REST_Response( array() );
diff --git a/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-run-controller.php b/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-run-controller.php
@@ -159,6 +159,7 @@ public function check_ability_permissions( $request ) {
 		}
 
 		$input    = $this->get_input_from_request( $request );
+		$input    = $ability->normalize_input( $input );
 		$is_valid = $ability->validate_input( $input );
 		if ( is_wp_error( $is_valid ) ) {
 			$is_valid->add_data( array( 'status' => 400 ) );
diff --git a/wp-includes/version.php b/wp-includes/version.php
@@ -16,7 +16,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '6.9-beta1-61046';
+$wp_version = '6.9-beta1-61047';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,7 @@ public function check_ability_permissions( $request ) {`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`$input = $this->get_input_from_request( $request );`
	`162`	`+ $input = $ability->normalize_input( $input );`
`162`	`163`	`$is_valid = $ability->validate_input( $input );`
`163`	`164`	`if ( is_wp_error( $is_valid ) ) {`
`164`	`165`	`$is_valid->add_data( array( 'status' => 400 ) );`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @global string $wp_version`
`18`	`18`	`*/`
`19`		`-$wp_version = '6.9-beta1-61046';`
	`19`	`+$wp_version = '6.9-beta1-61047';`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.`