Abilities API: rename the core/settings 'slugs' input to 'settings'

'settings' reads more naturally than 'slugs' for filtering an abilities-exposed
settings map by name.

Author: jorgefilipecosta

src/wp-includes/abilities/class-wp-settings-abilities.php

@@ -58,10 +58,10 @@ public static function register(): void {
 	 * @since 7.1.0
 	 */
 	public static function register_get_settings(): void {
-		$settings   = self::get_exposed_settings();
-		$groups     = array_values( array_unique( array_filter( wp_list_pluck( $settings, 'group' ) ) ) );
-		$slugs      = array_keys( $settings );
-		$properties = array();
+		$settings      = self::get_exposed_settings();
+		$groups        = array_values( array_unique( array_filter( wp_list_pluck( $settings, 'group' ) ) ) );
+		$setting_names = array_keys( $settings );
+		$properties    = array();
 		foreach ( $settings as $exposed_name => $setting ) {
 			$properties[ $exposed_name ] = $setting['schema'];
 		}
@@ -72,7 +72,7 @@ public static function register_get_settings(): void {
 				'label'               => __( 'Get Settings' ),
 				'description'         => __( 'Returns WordPress settings as a flat map of setting name to value. By default returns all settings exposed to abilities, or optionally a subset filtered by settings group or by setting name.' ),
 				'category'            => self::CATEGORY,
-				'input_schema'        => self::get_settings_input_schema( $groups, $slugs ),
+				'input_schema'        => self::get_settings_input_schema( $groups, $setting_names ),
 				'output_schema'       => array(
 					'type'                 => 'object',
 					'description'          => __( 'A map of setting name to its current value.' ),
@@ -106,14 +106,14 @@ public static function execute_get_settings( $input = array() ): array {
 
 		$settings = self::get_exposed_settings();
 		$group    = isset( $input['group'] ) ? (string) $input['group'] : '';
-		$slugs    = isset( $input['slugs'] ) && is_array( $input['slugs'] ) ? $input['slugs'] : array();
+		$names    = isset( $input['settings'] ) && is_array( $input['settings'] ) ? $input['settings'] : array();
 
 		$result = array();
 		foreach ( $settings as $exposed_name => $setting ) {
 			if ( '' !== $group && $setting['group'] !== $group ) {
 				continue;
 			}
-			if ( ! empty( $slugs ) && ! in_array( $exposed_name, $slugs, true ) ) {
+			if ( ! empty( $names ) && ! in_array( $exposed_name, $names, true ) ) {
 				continue;
 			}
 
@@ -142,11 +142,11 @@ public static function has_permission(): bool {
 	 *
 	 * @since 7.1.0
 	 *
-	 * @param string[] $groups Available settings groups.
-	 * @param string[] $slugs  Available exposed setting names.
+	 * @param string[] $groups        Available settings groups.
+	 * @param string[] $setting_names Available exposed setting names.
 	 * @return array<string, mixed> The input JSON Schema.
 	 */
-	protected static function get_settings_input_schema( array $groups, array $slugs ): array {
+	protected static function get_settings_input_schema( array $groups, array $setting_names ): array {
 		return array(
 			'type'    => 'object',
 			'default' => array(),
@@ -173,13 +173,13 @@ protected static function get_settings_input_schema( array $groups, array $slugs
 				array(
 					'title'                => __( 'Filter by name' ),
 					'type'                 => 'object',
-					'required'             => array( 'slugs' ),
+					'required'             => array( 'settings' ),
 					'properties'           => array(
-						'slugs' => array(
+						'settings' => array(
 							'type'        => 'array',
 							'items'       => array(
 								'type' => 'string',
-								'enum' => $slugs,
+								'enum' => $setting_names,
 							),
 							'description' => __( 'Return only the settings with these names.' ),
 						),

tests/phpunit/tests/abilities-api/wpRegisterCoreSettingsAbility.php

@@ -79,11 +79,11 @@ public function test_core_settings_ability_is_registered(): void {
 	}
 
 	/**
-	 * The input schema exposes mutually exclusive `group` and `slugs` filters.
+	 * The input schema exposes mutually exclusive `group` and `settings` filters.
 	 *
 	 * @ticket 64146
 	 */
-	public function test_core_settings_input_schema_is_one_of_group_or_slugs(): void {
+	public function test_core_settings_input_schema_is_one_of_group_or_settings(): void {
 		$schema = wp_get_ability( 'core/settings' )->get_input_schema();
 
 		$this->assertSame( 'object', $schema['type'] );
@@ -95,10 +95,10 @@ public function test_core_settings_input_schema_is_one_of_group_or_slugs(): void
 		$this->assertContains( 'general', $group_branch['properties']['group']['enum'] );
 		$this->assertContains( 'reading', $group_branch['properties']['group']['enum'] );
 
-		$slugs_branch = $schema['oneOf'][2];
-		$this->assertSame( array( 'slugs' ), $slugs_branch['required'] );
-		$this->assertContains( 'blogname', $slugs_branch['properties']['slugs']['items']['enum'] );
-		$this->assertContains( 'posts_per_page', $slugs_branch['properties']['slugs']['items']['enum'] );
+		$settings_branch = $schema['oneOf'][2];
+		$this->assertSame( array( 'settings' ), $settings_branch['required'] );
+		$this->assertContains( 'blogname', $settings_branch['properties']['settings']['items']['enum'] );
+		$this->assertContains( 'posts_per_page', $settings_branch['properties']['settings']['items']['enum'] );
 	}
 
 	/**
@@ -136,30 +136,30 @@ public function test_core_settings_filters_by_group(): void {
 	}
 
 	/**
-	 * The `slugs` filter narrows the response to the requested setting names.
+	 * The `settings` filter narrows the response to the requested setting names.
 	 *
 	 * @ticket 64146
 	 */
-	public function test_core_settings_filters_by_slugs(): void {
+	public function test_core_settings_filters_by_settings(): void {
 		$this->become_admin();
 
-		$result = wp_get_ability( 'core/settings' )->execute( array( 'slugs' => array( 'blogname', 'posts_per_page' ) ) );
+		$result = wp_get_ability( 'core/settings' )->execute( array( 'settings' => array( 'blogname', 'posts_per_page' ) ) );
 
 		$this->assertSame( array( 'blogname', 'posts_per_page' ), array_keys( $result ) );
 	}
 
 	/**
-	 * Supplying both `group` and `slugs` violates the `oneOf` and is rejected.
+	 * Supplying both `group` and `settings` violates the `oneOf` and is rejected.
 	 *
 	 * @ticket 64146
 	 */
-	public function test_core_settings_rejects_group_and_slugs_together(): void {
+	public function test_core_settings_rejects_group_and_settings_together(): void {
 		$this->become_admin();
 
 		$result = wp_get_ability( 'core/settings' )->execute(
 			array(
-				'group' => 'reading',
-				'slugs' => array( 'blogname' ),
+				'group'    => 'reading',
+				'settings' => array( 'blogname' ),
 			)
 		);