Docs: Add descriptions for some globals:

* `$wp_version`
* `$wp_local_package`
* `$required_php_version`
* `$required_mysql_version`

See #48303.
Built from https://develop.svn.wordpress.org/trunk@47230


git-svn-id: http://core.svn.wordpress.org/trunk@47030 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-02-10 03:30:06 +00:00
parent e4f36258f9
commit 32edd58e4c
13 changed files with 31 additions and 30 deletions

View File

@ -386,8 +386,8 @@ class Core_Upgrader extends WP_Upgrader {
* *
* @since 3.7.0 * @since 3.7.0
* *
* @global string $wp_version * @global string $wp_version The WordPress version string.
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* *
* @return bool True if the checksums match, otherwise false. * @return bool True if the checksums match, otherwise false.
*/ */

View File

@ -154,7 +154,7 @@ function wp_get_available_translations() {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* *
* @param array[] $languages Array of available languages (populated via the Translation API). * @param array[] $languages Array of available languages (populated via the Translation API).
*/ */

View File

@ -1380,7 +1380,7 @@ function _copy_dir( $from, $to, $skip_list = array() ) {
* *
* @since 3.3.0 * @since 3.3.0
* *
* @global string $wp_version * @global string $wp_version The WordPress version string.
* @global string $pagenow * @global string $pagenow
* @global string $action * @global string $action
* *

View File

@ -223,9 +223,9 @@ if ( is_blog_installed() ) {
} }
/** /**
* @global string $wp_version * @global string $wp_version The WordPress version string.
* @global string $required_php_version * @global string $required_php_version The required PHP version string.
* @global string $required_mysql_version * @global string $required_mysql_version The required MySQL version string.
*/ */
global $wp_version, $required_php_version, $required_mysql_version; global $wp_version, $required_php_version, $required_mysql_version;
@ -290,7 +290,7 @@ if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
} }
/** /**
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* @global WP_Locale $wp_locale WordPress date and time locale object. * @global WP_Locale $wp_locale WordPress date and time locale object.
*/ */
$language = ''; $language = '';

View File

@ -87,7 +87,7 @@ $step = isset( $_GET['step'] ) ? (int) $_GET['step'] : -1;
* @ignore * @ignore
* @since 2.3.0 * @since 2.3.0
* *
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* @global WP_Locale $wp_locale WordPress date and time locale object. * @global WP_Locale $wp_locale WordPress date and time locale object.
* *
* @param string|array $body_classes * @param string|array $body_classes

View File

@ -28,7 +28,7 @@ if ( ! current_user_can( 'update_core' ) && ! current_user_can( 'update_themes'
* *
* @since 2.7.0 * @since 2.7.0
* *
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @staticvar bool $first_pass * @staticvar bool $first_pass
@ -216,8 +216,8 @@ function dismissed_updates() {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @global string $required_php_version * @global string $required_php_version The required PHP version string.
* @global string $required_mysql_version * @global string $required_mysql_version The required MySQL version string.
*/ */
function core_upgrade_preamble() { function core_upgrade_preamble() {
global $required_php_version, $required_mysql_version; global $required_php_version, $required_mysql_version;

View File

@ -36,9 +36,9 @@ if ( 'upgrade_db' === $step ) {
} }
/** /**
* @global string $wp_version * @global string $wp_version The WordPress version string.
* @global string $required_php_version * @global string $required_php_version The required PHP version string.
* @global string $required_mysql_version * @global string $required_mysql_version The required MySQL version string.
*/ */
global $wp_version, $required_php_version, $required_mysql_version; global $wp_version, $required_php_version, $required_mysql_version;

View File

@ -115,7 +115,7 @@ class WP_Locale {
* @since 2.1.0 * @since 2.1.0
* *
* @global string $text_direction * @global string $text_direction
* @global string $wp_version * @global string $wp_version The WordPress version string.
*/ */
public function init() { public function init() {
// The weekdays. // The weekdays.

View File

@ -695,7 +695,7 @@ function bloginfo( $show = '' ) {
* *
* @since 0.71 * @since 0.71
* *
* @global string $wp_version * @global string $wp_version The WordPress version string.
* *
* @param string $show Optional. Site info to retrieve. Default empty (site name). * @param string $show Optional. Site info to retrieve. Default empty (site name).
* @param string $filter Optional. How to filter what is retrieved. Default 'raw'. * @param string $filter Optional. How to filter what is retrieved. Default 'raw'.

View File

@ -22,8 +22,8 @@
* *
* @since 1.5.0 * @since 1.5.0
* *
* @global string $locale * @global string $locale The current locale.
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* *
* @return string The locale of the blog or from the {@see 'locale'} hook. * @return string The locale of the blog or from the {@see 'locale'} hook.
*/ */

View File

@ -16,7 +16,7 @@
* @since 2.3.0 * @since 2.3.0
* @global string $wp_version Used to check against the newest WordPress version. * @global string $wp_version Used to check against the newest WordPress version.
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* @global string $wp_local_package * @global string $wp_local_package Locale code of the package.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
* @param bool $force_check Whether to bypass the transient cache and force a fresh update check. Defaults to false, true if $extra_stats is set. * @param bool $force_check Whether to bypass the transient cache and force a fresh update check. Defaults to false, true if $extra_stats is set.
@ -251,7 +251,7 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
* api.wordpress.org. Will only check if WordPress isn't installing. * api.wordpress.org. Will only check if WordPress isn't installing.
* *
* @since 2.3.0 * @since 2.3.0
* @global string $wp_version Used to notify the WordPress version. * @global string $wp_version The WordPress version string.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
*/ */
@ -432,6 +432,7 @@ function wp_update_plugins( $extra_stats = array() ) {
* installing. * installing.
* *
* @since 2.7.0 * @since 2.7.0
* @global string $wp_version The WordPress version string.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
*/ */
@ -725,7 +726,7 @@ function wp_get_update_data() {
* *
* @since 2.8.0 * @since 2.8.0
* *
* @global string $wp_version * @global string $wp_version The WordPress version string.
*/ */
function _maybe_update_core() { function _maybe_update_core() {
// Include an unmodified $wp_version. // Include an unmodified $wp_version.

View File

@ -9,11 +9,11 @@
*/ */
/** /**
* The WordPress version string * The WordPress version string.
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-47229'; $wp_version = '5.4-alpha-47230';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
@ -23,21 +23,21 @@ $wp_version = '5.4-alpha-47229';
$wp_db_version = 47018; $wp_db_version = 47018;
/** /**
* Holds the TinyMCE version * Holds the TinyMCE version.
* *
* @global string $tinymce_version * @global string $tinymce_version
*/ */
$tinymce_version = '4960-20190918'; $tinymce_version = '4960-20190918';
/** /**
* Holds the required PHP version * Holds the required PHP version.
* *
* @global string $required_php_version * @global string $required_php_version
*/ */
$required_php_version = '5.6.20'; $required_php_version = '5.6.20';
/** /**
* Holds the required MySQL version * Holds the required MySQL version.
* *
* @global string $required_mysql_version * @global string $required_mysql_version
*/ */

View File

@ -597,7 +597,7 @@ class wpdb {
* @link https://core.trac.wordpress.org/ticket/3354 * @link https://core.trac.wordpress.org/ticket/3354
* @since 2.0.8 * @since 2.0.8
* *
* @global string $wp_version * @global string $wp_version The WordPress version string.
* *
* @param string $dbuser MySQL database user * @param string $dbuser MySQL database user
* @param string $dbpassword MySQL database password * @param string $dbpassword MySQL database password
@ -3489,8 +3489,8 @@ class wpdb {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @global string $wp_version * @global string $wp_version The WordPress version string.
* @global string $required_mysql_version * @global string $required_mysql_version The required MySQL version string.
* *
* @return void|WP_Error * @return void|WP_Error
*/ */