Changeset 50395

Timestamp:

02/20/2021 05:08:24 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #51800

Location:

trunk/src/wp-includes

Files:

• class-wp-site.php (modified) (2 diffs)
• class-wp-term-query.php (modified) (1 diff)
• load.php (modified) (1 diff)
• theme.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-site.php

@@ -28 +28 @@
      * Site ID.
      *
+     * Named "blog" vs. "site" for legacy reasons.
+     *
      * A numeric string, for compatibility reasons.
      *
@@ -65 +67 @@
 
     /**
-     * The date on which the site was created or registered.
+     * The date and time on which the site was created or registered.
      *
      * @since 4.5.0

trunk/src/wp-includes/class-wp-term-query.php

@@ -332 +332 @@
      *   - 'tt_ids'
      *
-     * In all cases, a `WP_Error` object will be returned if an invalid taxonomy is used.
-     *
      * @since 4.6.0
      *

trunk/src/wp-includes/load.php

@@ -417 +417 @@
      * constants to not be checked and the default PHP values for errors
      * will be used unless you take care to update them yourself.
+     *
+     * To use this filter you must define a `$wp_filter` global before
+     * WordPress loads, usually in `wp-config.php`.
+     *
+     * Example:
+     *
+     *     $GLOBALS['wp_filter'] = array(
+     *         'enable_wp_debug_mode_checks' => array(
+     *             10 => array(
+     *                 array(
+     *                     'accepted_args' => 0,
+     *                     'function'      => function() {
+     *                         return false;
+     *                     },
+     *                 ),
+     *             ),
+     *         ),
+     *     );
      *
      * @since 4.6.0

trunk/src/wp-includes/theme.php

@@ -2486 +2486 @@
  * @global array $_wp_theme_features
  *
- * @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', 'wp-block-styles', and 'core-block-patterns'.
+ * @param string $feature The feature being added. Likely core values include:
+ *                          - 'admin-bar'
+ *                          - 'align-wide'
+ *                          - 'automatic-feed-links'
+ *                          - 'core-block-patterns'
+ *                          - 'custom-background'
+ *                          - 'custom-header'
+ *                          - 'custom-line-height'
+ *                          - 'custom-logo'
+ *                          - 'customize-selective-refresh-widgets'
+ *                          - 'custom-spacing'
+ *                          - 'custom-units'
+ *                          - 'dark-editor-style'
+ *                          - 'disable-custom-colors'
+ *                          - 'disable-custom-font-sizes'
+ *                          - 'editor-color-palette'
+ *                          - 'editor-gradient-presets'
+ *                          - 'editor-font-sizes'
+ *                          - 'editor-styles'
+ *                          - 'featured-content'
+ *                          - 'html5'
+ *                          - 'menus'
+ *                          - 'post-formats'
+ *                          - 'post-thumbnails'
+ *                          - 'responsive-embeds'
+ *                          - 'starter-content'
+ *                          - 'title-tag'
+ *                          - 'wp-block-styles'
+ *                          - 'widgets'
  * @param mixed  ...$args Optional extra arguments to pass along with certain features.
  * @return void|false Void on success, false on failure.