From e0311b76c7b19615208d6fa0130fd7f47a24a162 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov.ru@gmail.com>
Date: Sun, 4 Aug 2019 01:46:55 +0000
Subject: [PATCH] Docs: Add missing description for `$wp_locale` global.

Props mukesh27.
See #45604, #47110.
Built from https://develop.svn.wordpress.org/trunk@45737


git-svn-id: http://core.svn.wordpress.org/trunk@45548 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-admin/admin-header.php                            |  2 +-
 wp-admin/export.php                                  |  2 +-
 wp-admin/includes/class-wp-list-table.php            |  2 +-
 wp-admin/includes/media.php                          |  2 +-
 wp-admin/includes/template.php                       |  4 ++--
 wp-admin/install.php                                 |  2 +-
 wp-admin/options-general.php                         |  2 +-
 wp-admin/setup-config.php                            |  2 +-
 wp-includes/class-wp-locale-switcher.php             |  2 +-
 .../class-wp-customize-date-time-control.php         |  2 +-
 wp-includes/functions.php                            |  6 +++---
 wp-includes/general-template.php                     | 12 ++++++------
 wp-includes/l10n.php                                 |  2 +-
 wp-includes/load.php                                 |  2 +-
 wp-includes/media.php                                |  2 +-
 wp-includes/script-loader.php                        |  2 +-
 wp-includes/theme.php                                |  2 +-
 wp-includes/version.php                              |  2 +-
 wp-settings.php                                      |  2 +-
 19 files changed, 27 insertions(+), 27 deletions(-)

diff --git a/wp-admin/admin-header.php b/wp-admin/admin-header.php
index 8342c961ac..6d5718a4be 100644
--- a/wp-admin/admin-header.php
+++ b/wp-admin/admin-header.php
@@ -17,7 +17,7 @@ if ( ! defined( 'WP_ADMIN' ) ) {
  * @global string    $title
  * @global string    $hook_suffix
  * @global WP_Screen $current_screen
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale          WordPress date and time locale object.
  * @global string    $pagenow
  * @global string    $update_title
  * @global int       $total_update_count
diff --git a/wp-admin/export.php b/wp-admin/export.php
index 43fd963602..759723456e 100644
--- a/wp-admin/export.php
+++ b/wp-admin/export.php
@@ -128,7 +128,7 @@ require_once( ABSPATH . 'wp-admin/admin-header.php' );
  * Create the date options fields for exporting a given post type.
  *
  * @global wpdb      $wpdb      WordPress database abstraction object.
- * @global WP_Locale $wp_locale Date and Time Locale object.
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @since 3.1.0
  *
diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php
index c9d315eeba..6923da55bc 100644
--- a/wp-admin/includes/class-wp-list-table.php
+++ b/wp-admin/includes/class-wp-list-table.php
@@ -536,7 +536,7 @@ class WP_List_Table {
 	 * @since 3.1.0
 	 *
 	 * @global wpdb      $wpdb      WordPress database abstraction object.
-	 * @global WP_Locale $wp_locale
+	 * @global WP_Locale $wp_locale WordPress date and time locale object.
 	 *
 	 * @param string $post_type
 	 */
diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php
index 0c68ccfc78..6466706385 100644
--- a/wp-admin/includes/media.php
+++ b/wp-admin/includes/media.php
@@ -2528,7 +2528,7 @@ jQuery(function($){
  *
  * @global wpdb      $wpdb            WordPress database abstraction object.
  * @global WP_Query  $wp_query
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale       WordPress date and time locale object.
  * @global string    $type
  * @global string    $tab
  * @global array     $post_mime_types
diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php
index 00faff777e..be6d02809a 100644
--- a/wp-admin/includes/template.php
+++ b/wp-admin/includes/template.php
@@ -757,7 +757,7 @@ function meta_form( $post = null ) {
  * @since 0.71
  * @since 4.4.0 Converted to use get_comment() instead of the global `$comment`.
  *
- * @global WP_Locale  $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param int|bool $edit      Accepts 1|true for editing the date, 0|false for adding the date.
  * @param int|bool $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
@@ -1905,7 +1905,7 @@ function _admin_search_query() {
  *
  * @global string    $hook_suffix
  * @global string    $admin_body_class
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale        WordPress date and time locale object.
  *
  * @param string $title      Optional. Title of the Iframe page. Default empty.
  * @param bool   $deprecated Not used.
diff --git a/wp-admin/install.php b/wp-admin/install.php
index bebf02b124..472e6b77a0 100644
--- a/wp-admin/install.php
+++ b/wp-admin/install.php
@@ -291,7 +291,7 @@ if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
 
 /**
  * @global string    $wp_local_package
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale        WordPress date and time locale object.
  */
 $language = '';
 if ( ! empty( $_REQUEST['language'] ) ) {
diff --git a/wp-admin/options-general.php b/wp-admin/options-general.php
index 2e2b7f8901..633aa92dc2 100644
--- a/wp-admin/options-general.php
+++ b/wp-admin/options-general.php
@@ -386,7 +386,7 @@ foreach ( $time_formats as $format ) {
 <td><select name="start_of_week" id="start_of_week">
 <?php
 /**
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  */
 global $wp_locale;
 
diff --git a/wp-admin/setup-config.php b/wp-admin/setup-config.php
index 24106e9fa1..10a74e014d 100644
--- a/wp-admin/setup-config.php
+++ b/wp-admin/setup-config.php
@@ -88,7 +88,7 @@ $step = isset( $_GET['step'] ) ? (int) $_GET['step'] : -1;
  * @since 2.3.0
  *
  * @global string    $wp_local_package
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale        WordPress date and time locale object.
  *
  * @param string|array $body_classes
  */
diff --git a/wp-includes/class-wp-locale-switcher.php b/wp-includes/class-wp-locale-switcher.php
index 21881771d4..7ec7622161 100644
--- a/wp-includes/class-wp-locale-switcher.php
+++ b/wp-includes/class-wp-locale-switcher.php
@@ -213,7 +213,7 @@ class WP_Locale_Switcher {
 	 *
 	 * @since 4.7.0
 	 *
-	 * @global WP_Locale $wp_locale The WordPress date and time locale object.
+	 * @global WP_Locale $wp_locale WordPress date and time locale object.
 	 *
 	 * @param string $locale The locale to change to.
 	 */
diff --git a/wp-includes/customize/class-wp-customize-date-time-control.php b/wp-includes/customize/class-wp-customize-date-time-control.php
index 6325194395..7eea180f74 100644
--- a/wp-includes/customize/class-wp-customize-date-time-control.php
+++ b/wp-includes/customize/class-wp-customize-date-time-control.php
@@ -189,7 +189,7 @@ class WP_Customize_Date_Time_Control extends WP_Customize_Control {
 	 * @since 4.9.0
 	 * @see touch_time()
 	 *
-	 * @global WP_Locale $wp_locale
+	 * @global WP_Locale $wp_locale WordPress date and time locale object.
 	 *
 	 * @return array
 	 */
diff --git a/wp-includes/functions.php b/wp-includes/functions.php
index c3dadd9312..0074b240d1 100644
--- a/wp-includes/functions.php
+++ b/wp-includes/functions.php
@@ -83,7 +83,7 @@ function current_time( $type, $gmt = 0 ) {
  *
  * @since 0.71
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param string   $dateformatstring      Format to display the date.
  * @param int|bool $timestamp_with_offset Optional. A sum of Unix timestamp and timezone offset in seconds.
@@ -202,7 +202,7 @@ function date_i18n( $dateformatstring, $timestamp_with_offset = false, $gmt = fa
  *
  * @since 4.4.0
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param string $date Formatted date string.
  * @return string The date, declined if locale specifies it.
@@ -267,7 +267,7 @@ function wp_maybe_decline_date( $date ) {
  *
  * @since 2.3.0
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param float $number   The number to convert based on locale.
  * @param int   $decimals Optional. Precision of the number of decimal places. Default 0.
diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php
index 62c01d86a6..8816f4706a 100644
--- a/wp-includes/general-template.php
+++ b/wp-includes/general-template.php
@@ -1174,7 +1174,7 @@ function _wp_render_title_tag() {
  *
  * @since 1.0.0
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param string $sep         Optional, default is '&raquo;'. How to separate the various items
  *                            within the page title.
@@ -1495,7 +1495,7 @@ function single_term_title( $prefix = '', $display = true ) {
  *
  * @since 0.71
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param string $prefix  Optional. What to display before the title.
  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
@@ -1772,7 +1772,7 @@ function get_archives_link( $url, $text, $format = 'html', $before = '', $after
  * @see get_archives_link()
  *
  * @global wpdb      $wpdb      WordPress database abstraction object.
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param string|array $args {
  *     Default archive links arguments. Optional.
@@ -2045,7 +2045,7 @@ function calendar_week_mod( $num ) {
  * @global int       $m
  * @global int       $monthnum
  * @global int       $year
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  * @global array     $posts
  *
  * @param bool $initial Optional, default is true. Use initial calendar names.
@@ -2685,7 +2685,7 @@ function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translat
  *
  * @since 0.71
  *
- * @global WP_Locale $wp_locale The WordPress date and time locale object.
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  */
 function the_weekday() {
 	global $wp_locale;
@@ -2716,7 +2716,7 @@ function the_weekday() {
  *
  * @since 0.71
  *
- * @global WP_Locale $wp_locale       The WordPress date and time locale object.
+ * @global WP_Locale $wp_locale       WordPress date and time locale object.
  * @global string    $currentday      The day of the current post in the loop.
  * @global string    $previousweekday The day of the previous post in the loop.
  *
diff --git a/wp-includes/l10n.php b/wp-includes/l10n.php
index bd0110d780..956cabe9a4 100644
--- a/wp-includes/l10n.php
+++ b/wp-includes/l10n.php
@@ -1553,7 +1553,7 @@ function wp_dropdown_languages( $args = array() ) {
  *
  * @since 3.0.0
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @return bool Whether locale is RTL.
  */
diff --git a/wp-includes/load.php b/wp-includes/load.php
index 9de4a90eb8..57fd841703 100644
--- a/wp-includes/load.php
+++ b/wp-includes/load.php
@@ -1141,7 +1141,7 @@ function get_current_network_id() {
  * @since 3.4.0
  * @access private
  *
- * @global WP_Locale $wp_locale The WordPress date and time locale object.
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @staticvar bool $loaded
  */
diff --git a/wp-includes/media.php b/wp-includes/media.php
index 82905aa658..c5404d5383 100644
--- a/wp-includes/media.php
+++ b/wp-includes/media.php
@@ -3561,7 +3561,7 @@ function wp_prepare_attachment_for_js( $attachment ) {
  *
  * @global int       $content_width
  * @global wpdb      $wpdb          WordPress database abstraction object.
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale     WordPress date and time locale object.
  *
  * @param array $args {
  *     Arguments for enqueuing media scripts.
diff --git a/wp-includes/script-loader.php b/wp-includes/script-loader.php
index 5dc797425e..720c2c9ced 100644
--- a/wp-includes/script-loader.php
+++ b/wp-includes/script-loader.php
@@ -2184,7 +2184,7 @@ function wp_just_in_time_script_localization() {
  *
  * @link https://api.jqueryui.com/datepicker/#options
  *
- * @global WP_Locale $wp_locale The WordPress date and time locale object.
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  */
 function wp_localize_jquery_ui_datepicker() {
 	global $wp_locale;
diff --git a/wp-includes/theme.php b/wp-includes/theme.php
index 3b2a019c9f..bed9230d86 100644
--- a/wp-includes/theme.php
+++ b/wp-includes/theme.php
@@ -266,7 +266,7 @@ function get_stylesheet_uri() {
  *
  * @since 2.1.0
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @return string
  */
diff --git a/wp-includes/version.php b/wp-includes/version.php
index 355befab19..b1b6b04fcb 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -13,7 +13,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '5.3-alpha-45736';
+$wp_version = '5.3-alpha-45737';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
diff --git a/wp-settings.php b/wp-settings.php
index 9a53ad8bae..73b721433b 100644
--- a/wp-settings.php
+++ b/wp-settings.php
@@ -475,7 +475,7 @@ unset( $locale_file );
 /**
  * WordPress Locale object for loading locale domain date and various strings.
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  * @since 2.1.0
  */
 $GLOBALS['wp_locale'] = new WP_Locale();