Changeset 40603

Timestamp:

05/10/2017 06:09:36 AM (7 years ago)

Author:

rmccue

Message:

Options/Meta: Document valid types for registration.

In 4.7, the REST API introduced types for options and meta passed into the registration functions. This adds the documentation for those types.

Props iandunn, priyankabehera155.
Fixes #40318.

Location:

trunk/src/wp-includes

Files:

• meta.php (modified) (1 diff)
• option.php (modified) (1 diff)

trunk/src/wp-includes/meta.php

@@ -975 +975 @@
  *
  *     @type string $type              The type of data associated with this meta key.
+ *                                     Valid values are 'string', 'boolean', 'integer', and 'number'.
  *     @type string $description       A description of the data attached to this meta key.
  *     @type bool   $single            Whether the meta key has one value per object, or an array of values per object.

trunk/src/wp-includes/option.php

@@ -1872 +1872 @@
  *
  *     @type string   $type              The type of data associated with this setting.
+ *                                       Valid values are 'string', 'boolean', 'integer', and 'number'.
  *     @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.