Changeset 47157

Timestamp:

02/01/2020 09:59:14 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct DocBlock formatting for register_setting().

Document the full list of whitelisted option key names.

See #48303.

Location:

trunk/src

Files:

• wp-admin/includes/deprecated.php (modified) (1 diff)
• wp-admin/options.php (modified) (1 diff)
• wp-includes/nav-menu.php (modified) (3 diffs)
• wp-includes/option.php (modified) (1 diff)

trunk/src/wp-admin/includes/deprecated.php

@@ -161 +161 @@
  *
  * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
- *  Default whitelisted option key names include "general," "discussion," and "reading," among others.
+ *                             Default whitelisted option key names include 'general', 'discussion', 'media',
+ *                             'reading', 'writing', 'misc', 'options', and 'privacy'.
  * @param string $option_name The name of an option to sanitize and save.
  * @param callable $sanitize_callback A callback function that sanitizes the option's value.

trunk/src/wp-admin/options.php

@@ -197 +197 @@
 
 /**
- * Filters the options white list.
+ * Filters the options whitelist.
  *
  * @since 2.7.0
  *
- * @param array $whitelist_options White list options.
+ * @param array $whitelist_options Whitelist options.
  */
 $whitelist_options = apply_filters( 'whitelist_options', $whitelist_options );

trunk/src/wp-includes/nav-menu.php

@@ -788 +788 @@
  * - description:      The description of this menu item.
  * - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
- * - object:           The type of object originally represented, such as "category," "post", or "attachment."
+ * - object:           The type of object originally represented, such as 'category', 'post', or 'attachment'.
  * - object_id:        The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
  * - post_parent:      The DB ID of the original object's parent object, if any (0 otherwise).
@@ -794 +794 @@
  * - target:           The target attribute of the link element for this menu item.
  * - title:            The title of this menu item.
- * - type:             The family of objects originally represented, such as "post_type" or "taxonomy."
+ * - type:             The family of objects originally represented, such as 'post_type' or 'taxonomy'.
  * - type_label:       The singular label used to describe this type of menu item.
  * - url:              The URL to which this menu item points.
@@ -983 +983 @@
  *
  * @param int    $object_id   The ID of the original object.
- * @param string $object_type The type of object, such as "taxonomy" or "post_type."
- * @param string $taxonomy    If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
+ * @param string $object_type The type of object, such as 'taxonomy' or 'post_type'.
+ * @param string $taxonomy    If $object_type is 'taxonomy', $taxonomy is the name of the tax
+ *                            that $object_id belongs to.
  * @return int[] The array of menu item IDs; empty array if none;
  */

trunk/src/wp-includes/option.php

@@ -2099 +2099 @@
  *
  * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
- *  Default whitelisted option key names include "general," "discussion," and "reading," among others.
+ *                             Default whitelisted option key names include 'general', 'discussion', 'media',
+ *                             'reading', 'writing', 'misc', 'options', and 'privacy'.
  * @param string $option_name The name of an option to sanitize and save.
  * @param array  $args {