Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Options: Add 'label' argument to register_setting #6495

Closed
wants to merge 6 commits into from
Closed

Options: Add 'label' argument to register_setting #6495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ef5d44
Options: Add 'label' argument to register_setting
Mamaduka May 3, 2024
8f05906
Add labels for the settings used by the block editor
Mamaduka May 3, 2024
04d1a06
Add unit test
Mamaduka May 3, 2024
06366dc
Match schema specs
Mamaduka May 3, 2024
22c9237
Update WP API fixtures
Mamaduka May 3, 2024
8f30043
Update WP API fixtures once more
Mamaduka May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/wp-includes/option.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2554,6 +2554,7 @@ function register_initial_settings() {
'name' => 'title',
),
'type' => 'string',
'label' => __( 'Title' ),
'description' => __( 'Site title.' ),
)
);
Expand All @@ -2566,6 +2567,7 @@ function register_initial_settings() {
'name' => 'description',
),
'type' => 'string',
'label' => __( 'Tagline' ),
'description' => __( 'Site tagline.' ),
)
);
Expand Down Expand Up @@ -2696,6 +2698,7 @@ function register_initial_settings() {
array(
'show_in_rest' => true,
'type' => 'integer',
'label' => __( 'Maximum posts per page' ),
'description' => __( 'Blog pages show at most.' ),
'default' => 10,
)
Expand All @@ -2707,6 +2710,7 @@ function register_initial_settings() {
array(
'show_in_rest' => true,
'type' => 'string',
'label' => __( 'Show on front' ),
'description' => __( 'What to show on the front page' ),
)
);
Expand All @@ -2717,6 +2721,7 @@ function register_initial_settings() {
array(
'show_in_rest' => true,
'type' => 'integer',
'label' => __( 'Page on front' ),
'description' => __( 'The ID of the page that should be displayed on the front page' ),
)
);
Expand Down Expand Up @@ -2755,6 +2760,7 @@ function register_initial_settings() {
),
),
'type' => 'string',
'label' => __( 'Allow comments on new posts' ),
'description' => __( 'Allow people to submit comments on new posts.' ),
)
);
Expand All @@ -2769,6 +2775,7 @@ function register_initial_settings() {
* @since 4.7.0 `$args` can be passed to set flags on the setting, similar to `register_meta()`.
* @since 5.5.0 `$new_whitelist_options` was renamed to `$new_allowed_options`.
* Please consider writing more inclusive code.
* @since 6.6.0 Added the `label` argument.
*
* @global array $new_allowed_options
* @global array $wp_registered_settings
Expand All @@ -2782,6 +2789,7 @@ function register_initial_settings() {
*
* @type string $type The type of data associated with this setting.
* Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
* @type string $label A label of the data attached to this setting.
* @type string $description A description of the data attached to this setting.
* @type callable $sanitize_callback A callback function that sanitizes the option's value.
* @type bool|array $show_in_rest Whether data associated with this setting should be included in the REST API.
Expand All @@ -2802,6 +2810,7 @@ function register_setting( $option_group, $option_name, $args = array() ) {
$defaults = array(
'type' => 'string',
'group' => $option_group,
'label' => '',
'description' => '',
'sanitize_callback' => null,
'show_in_rest' => false,
Expand Down
1 change: 1 addition & 0 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ protected function get_registered_options() {

$default_schema = array(
'type' => empty( $args['type'] ) ? null : $args['type'],
'title' => empty( $args['label'] ) ? '' : $args['label'],
'description' => empty( $args['description'] ) ? '' : $args['description'],
'default' => isset( $args['default'] ) ? $args['default'] : null,
);
Expand Down
15 changes: 15 additions & 0 deletions tests/phpunit/tests/rest-api/rest-settings-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -781,4 +781,19 @@ public function test_register_setting_with_custom_additional_properties_value()
$this->assertSame( 2, $response->data['mycustomsetting']['test2'] );
$this->assertSame( 3, $response->data['mycustomsetting']['test3'] );
}

/**
* @ticket 61023
*/
public function test_provides_setting_metadata_in_schema() {
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/settings' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$title = $data['schema']['properties']['title'];

$this->assertSame( 'string', $title['type'] );
$this->assertSame( 'Title', $title['title'] );
$this->assertSame( 'Site title.', $title['description'] );
$this->assertSame( null, $title['default'] );
}
}
20 changes: 20 additions & 0 deletions tests/qunit/fixtures/wp-api-generated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10618,88 +10618,105 @@ mockedApiResponse.Schema = {
],
"args": {
"title": {
"title": "Title",
"description": "Site title.",
"type": "string",
"required": false
},
"description": {
"title": "Tagline",
"description": "Site tagline.",
"type": "string",
"required": false
},
"url": {
"title": "",
"description": "Site URL.",
"type": "string",
"format": "uri",
"required": false
},
"email": {
"title": "",
"description": "This address is used for admin purposes, like new user notification.",
"type": "string",
"format": "email",
"required": false
},
"timezone": {
"title": "",
"description": "A city in the same timezone as you.",
"type": "string",
"required": false
},
"date_format": {
"title": "",
"description": "A date format for all date strings.",
"type": "string",
"required": false
},
"time_format": {
"title": "",
"description": "A time format for all time strings.",
"type": "string",
"required": false
},
"start_of_week": {
"title": "",
"description": "A day number of the week that the week should start on.",
"type": "integer",
"required": false
},
"language": {
"title": "",
"description": "WordPress locale code.",
"type": "string",
"required": false
},
"use_smilies": {
"title": "",
"description": "Convert emoticons like :-) and :-P to graphics on display.",
"type": "boolean",
"required": false
},
"default_category": {
"title": "",
"description": "Default post category.",
"type": "integer",
"required": false
},
"default_post_format": {
"title": "",
"description": "Default post format.",
"type": "string",
"required": false
},
"posts_per_page": {
"title": "Maximum posts per page",
"description": "Blog pages show at most.",
"type": "integer",
"required": false
},
"show_on_front": {
"title": "Show on front",
"description": "What to show on the front page",
"type": "string",
"required": false
},
"page_on_front": {
"title": "Page on front",
"description": "The ID of the page that should be displayed on the front page",
"type": "integer",
"required": false
},
"page_for_posts": {
"title": "",
"description": "The ID of the page that should display the latest posts",
"type": "integer",
"required": false
},
"default_ping_status": {
"title": "",
"description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.",
"type": "string",
"enum": [
Expand All @@ -10709,6 +10726,7 @@ mockedApiResponse.Schema = {
"required": false
},
"default_comment_status": {
"title": "Allow comments on new posts",
"description": "Allow people to submit comments on new posts.",
"type": "string",
"enum": [
Expand All @@ -10718,11 +10736,13 @@ mockedApiResponse.Schema = {
"required": false
},
"site_logo": {
"title": "",
"description": "Site logo.",
"type": "integer",
"required": false
},
"site_icon": {
"title": "",
"description": "Site icon.",
"type": "integer",
"required": false
Expand Down
Loading