Changeset 48490

Timestamp:

07/15/2020 11:21:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Link to add_theme_support() for the list of supported theme features in current_theme_supports() and related functions.

Props stevenlinx.
Fixes #50657.

File:

• trunk/src/wp-includes/theme.php (modified) (10 diffs)

trunk/src/wp-includes/theme.php

@@ -2474 +2474 @@
  * @global array $_wp_theme_features
  *
- * @param string $feature The feature being added. Likely core values include 'post-formats',
- *                        'post-thumbnails', 'html5', 'custom-logo', 'custom-header',
- *                        'custom-background', 'title-tag', 'starter-content',
- *                        'responsive-embeds', etc.
+ * @param string $feature The feature being added. Likely core values include 'post-formats', 'post-thumbnails',
+ *                        'custom-header', 'custom-background', 'custom-logo', 'menus', 'automatic-feed-links',
+ *                        'html5', 'title-tag', 'customize-selective-refresh-widgets', 'starter-content',
+ *                        'responsive-embeds', 'align-wide', 'dark-editor-style', 'disable-custom-colors',
+ *                        'disable-custom-font-sizes', 'editor-color-palette', 'editor-font-sizes',
+ *                        'editor-styles', and 'wp-block-styles'.
  * @param mixed  ...$args Optional extra arguments to pass along with certain features.
  * @return void|bool False on failure, void otherwise.
@@ -2779 +2781 @@
 
 /**
- * Gets the theme support arguments passed when registering that support
+ * Gets the theme support arguments passed when registering that support.
  *
  * Example usage:
@@ -2792 +2794 @@
  * @global array $_wp_theme_features
  *
- * @param string $feature The feature to check.
+ * @param string $feature The feature to check. See add_theme_support() for the list
+ *                        of possible values.
  * @param mixed  ...$args Optional extra arguments to be checked against certain features.
  * @return mixed The array of extra arguments or the value for the registered feature.
@@ -2830 +2833 @@
  * @see add_theme_support()
  *
- * @param string $feature The feature being removed.
+ * @param string $feature The feature being removed. See add_theme_support() for the list
+ *                        of possible values.
  * @return bool|void Whether feature was removed.
  */
@@ -2852 +2856 @@
  * @global Custom_Background   $custom_background
  *
- * @param string $feature
+ * @param string $feature The feature being removed. See add_theme_support() for the list
+ *                        of possible values.
  * @return bool True if support was removed, false if the feature was not registered.
  */
@@ -2918 +2923 @@
  * @global array $_wp_theme_features
  *
- * @param string $feature The feature being checked.
+ * @param string $feature The feature being checked. See add_theme_support() for the list
+ *                        of possible values.
  * @param mixed  ...$args Optional extra arguments to be checked against certain features.
  * @return bool True if the current theme supports the feature, false otherwise.
@@ -2972 +2978 @@
      * Filters whether the current theme supports a specific feature.
      *
-     * The dynamic portion of the hook name, `$feature`, refers to the specific theme
-     * feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
-     * 'custom-header', 'menus', 'automatic-feed-links', 'html5',
-     * 'starter-content', and 'customize-selective-refresh-widgets'.
+     * The dynamic portion of the hook name, `$feature`, refers to the specific
+     * theme feature. See add_theme_support() for the list of possible values.
      *
      * @since 3.4.0
@@ -2991 +2995 @@
  * @since 2.9.0
  *
- * @param string $feature The feature being checked.
+ * @param string $feature The feature being checked. See add_theme_support() for the list
+ *                        of possible values.
  * @param string $include Path to the file.
  * @return bool True if the current theme supports the supplied feature, false otherwise.
@@ -3015 +3020 @@
  * @global $_wp_registered_theme_features
  *
- * @param string $feature The name uniquely identifying the feature.
+ * @param string $feature The name uniquely identifying the feature. See add_theme_support()
+ *                        for the list of possible values.
  * @param array $args {
  *      Data used to describe the theme.
@@ -3170 +3176 @@
  * @global $_wp_registered_theme_features
  *
- * @param string $feature The feature name.
+ * @param string $feature The feature name. See add_theme_support() for the list
+ *                        of possible values.
  * @return array|null The registration args, or null if the feature was not registered.
  */