Changeset 58230 for trunk/src/wp-includes/option.php

Timestamp:

05/29/2024 08:51:04 AM (7 months ago)

Author:

ellatrix

Message:

Options: Add 'label' argument to register_setting.

The 'label' will displayed to users when editing core or custom settings via block editors. It avoids hardcoding Settings labels and improves extensibility.

Backports ​https://github.com/WordPress/gutenberg/pull/59243.

Props mamaduka, timothyblynjacobs, ellatrix.

Fixes #61023.

File:

• trunk/src/wp-includes/option.php (modified) (9 diffs)

trunk/src/wp-includes/option.php

@@ -2660 +2660 @@
             ),
             'type'         => 'string',
+            'label'        => __( 'Title' ),
             'description'  => __( 'Site title.' ),
         )
@@ -2672 +2673 @@
             ),
             'type'         => 'string',
+            'label'        => __( 'Tagline' ),
             'description'  => __( 'Site tagline.' ),
         )
@@ -2802 +2804 @@
             'show_in_rest' => true,
             'type'         => 'integer',
+            'label'        => __( 'Maximum posts per page' ),
             'description'  => __( 'Blog pages show at most.' ),
             'default'      => 10,
@@ -2813 +2816 @@
             'show_in_rest' => true,
             'type'         => 'string',
+            'label'        => __( 'Show on front' ),
             'description'  => __( 'What to show on the front page' ),
         )
@@ -2823 +2827 @@
             'show_in_rest' => true,
             'type'         => 'integer',
+            'label'        => __( 'Page on front' ),
             'description'  => __( 'The ID of the page that should be displayed on the front page' ),
         )
@@ -2861 +2866 @@
             ),
             'type'         => 'string',
+            'label'        => __( 'Allow comments on new posts' ),
             'description'  => __( 'Allow people to submit comments on new posts.' ),
         )
@@ -2875 +2881 @@
  * @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
@@ -2888 +2895 @@
  *     @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.
@@ -2908 +2916 @@
         'type'              => 'string',
         'group'             => $option_group,
+        'label'             => '',
         'description'       => '',
         'sanitize_callback' => null,