Changeset 41965

Timestamp:

10/21/2017 01:45:05 PM (7 years ago)

Author:

pento

Message:

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.

File:

• trunk/src/wp-includes/update.php (modified) (2 diffs)

trunk/src/wp-includes/update.php

@@ -100 +100 @@
     /**
      * 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.
@@ -106 +106 @@
      * @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 );