From 2ce903ffc3fa93cecc89ed76da0eccc466f71a17 Mon Sep 17 00:00:00 2001 From: Gary Pendergast Date: Sat, 21 Oct 2017 13:45:05 +0000 Subject: [PATCH] Docs: Expand the docs for the `core_version_check_query_args` filter. Add documentation for the parameters in the `$query` parameter. Props MattyRob. Fixes #16778. git-svn-id: https://develop.svn.wordpress.org/trunk@41965 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/update.php | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/update.php b/src/wp-includes/update.php index 4b6f1851b7..87a07503ac 100644 --- a/src/wp-includes/update.php +++ b/src/wp-includes/update.php @@ -99,13 +99,25 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) { /** * Filter the query arguments sent as part of the core version check. - * + * * WARNING: Changing this data may result in your site not receiving security updates. * Please exercise extreme caution. * * @since 4.9.0 * - * @param array $query Version check query arguments. + * @param array $query { + * Version check query arguments. + * + * @type string $version WordPress version number. + * @type string $php PHP version number. + * @type string $locale The locale to retrieve updates for. + * @type string $mysql MySQL version number. + * @type string $local_package The value of the $wp_local_package global, when set. + * @type int $blogs Number of blogs on this WordPress install. + * @type int $users Number of sites on this WordPress install. + * @type int $multisite_enabled Whether this WordPress install uses multisite. + * @type int $initial_db_version Database version of WordPress at time of installation. + * } */ $query = apply_filters( 'core_version_check_query_args', $query );