summaryrefslogtreecommitdiffstatshomepage
path: root/src/wp-includes/option.php
diff options
context:
space:
mode:
Diffstat (limited to 'src/wp-includes/option.php')
-rw-r--r--src/wp-includes/option.php18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/wp-includes/option.php b/src/wp-includes/option.php
index 9760304efc..0280d53758 100644
--- a/src/wp-includes/option.php
+++ b/src/wp-includes/option.php
@@ -3176,7 +3176,23 @@ function unregister_setting( $option_group, $option_name, $deprecated = '' ) {
*
* @global array $wp_registered_settings
*
- * @return array List of registered settings, keyed by option name.
+ * @return array {
+ * List of registered settings, keyed by option name.
+ *
+ * @type array ...$0 {
+ * Data used to describe the setting when registered.
+ *
+ * @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.
+ * When registering complex settings, this argument may optionally be an
+ * array with a 'schema' key.
+ * @type mixed $default Default value when calling `get_option()`.
+ * }
+ * }
*/
function get_registered_settings() {
global $wp_registered_settings;