From 9ab39e33632d67883ca19f79b889849e40623d1c Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Sat, 20 Feb 2021 17:08:24 +0000 Subject: [PATCH] Docs: Various docblock corrections and improvements. See #51800 git-svn-id: https://develop.svn.wordpress.org/trunk@50395 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-site.php | 4 ++- src/wp-includes/class-wp-term-query.php | 2 -- src/wp-includes/load.php | 18 +++++++++++++ src/wp-includes/theme.php | 35 ++++++++++++++++++++----- 4 files changed, 50 insertions(+), 9 deletions(-) diff --git a/src/wp-includes/class-wp-site.php b/src/wp-includes/class-wp-site.php index e1839fed9e..1e253ec636 100644 --- a/src/wp-includes/class-wp-site.php +++ b/src/wp-includes/class-wp-site.php @@ -27,6 +27,8 @@ final class WP_Site { /** * Site ID. * + * Named "blog" vs. "site" for legacy reasons. + * * A numeric string, for compatibility reasons. * * @since 4.5.0 @@ -64,7 +66,7 @@ final class WP_Site { public $site_id = '0'; /** - * 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 * @var string Date in MySQL's datetime format. diff --git a/src/wp-includes/class-wp-term-query.php b/src/wp-includes/class-wp-term-query.php index 0f679535c3..465bcb7156 100644 --- a/src/wp-includes/class-wp-term-query.php +++ b/src/wp-includes/class-wp-term-query.php @@ -331,8 +331,6 @@ class WP_Term_Query { * - 'ids' * - 'tt_ids' * - * In all cases, a `WP_Error` object will be returned if an invalid taxonomy is used. - * * @since 4.6.0 * * @global wpdb $wpdb WordPress database abstraction object. diff --git a/src/wp-includes/load.php b/src/wp-includes/load.php index a68e6db435..897e018ab3 100644 --- a/src/wp-includes/load.php +++ b/src/wp-includes/load.php @@ -417,6 +417,24 @@ function wp_debug_mode() { * 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 * * @param bool $enable_debug_mode Whether to enable debug mode checks to occur. Default true. diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php index 916c836f43..458b8e6b3a 100644 --- a/src/wp-includes/theme.php +++ b/src/wp-includes/theme.php @@ -2485,12 +2485,35 @@ function get_theme_starter_content() { * * @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. */