Changeset 47231

Timestamp:

02/10/2020 03:32:57 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add documentation for globals in wp-settings.php.

Props chinteshprajapati.
Fixes #46253.

File:

• trunk/src/wp-settings.php (modified) (3 diffs)

trunk/src/wp-settings.php

@@ -16 +16 @@
 define( 'WPINC', 'wp-includes' );
 
-/*
+/**
+ * Version information for the current WordPress release.
+ *
  * These can't be directly globalized in version.php. When updating,
  * we're including version.php from another installation and don't want
  * these values to be overridden if already set.
+ *
+ * @global string $wp_version             The WordPress version string.
+ * @global int    $wp_db_version          WordPress database version.
+ * @global string $tinymce_version        TinyMCE version.
+ * @global string $required_php_version   The required PHP version string.
+ * @global string $required_mysql_version The required MySQL version string.
+ * @global string $wp_local_package       Locale code of the package.
  */
 global $wp_version, $wp_db_version, $tinymce_version, $required_php_version, $required_mysql_version, $wp_local_package;
@@ -109 +118 @@
 require ABSPATH . WPINC . '/pomo/mo.php';
 
+/**
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @since 0.71
+ */
+global $wpdb;
 // Include the wpdb class and, if present, a db.php database drop-in.
-global $wpdb;
 require_wp_db();
 
@@ -487 +500 @@
 
 /**
- *  WordPress Locale Switcher object for switching locales.
+ * WordPress Locale Switcher object for switching locales.
  *
  * @since 4.7.0