Docs: Add missing description for $wp_locale global.

SergeyBiryukov · SergeyBiryukov · commit 1e6420ba556d · 2019-08-04T01:45:03.000Z
Props mukesh27. See #45604, #47110. git-svn-id: https://develop.svn.wordpress.org/trunk@45737 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/admin-header.php b/src/wp-admin/admin-header.php
@@ -17,7 +17,7 @@
  * @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/src/wp-admin/export.php b/src/wp-admin/export.php
@@ -128,7 +128,7 @@ function export_add_js() {
  * 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/src/wp-admin/includes/class-wp-list-table.php b/src/wp-admin/includes/class-wp-list-table.php
@@ -536,7 +536,7 @@ protected function row_actions( $actions, $always_visible = false ) {
 	 * @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/src/wp-admin/includes/media.php b/src/wp-admin/includes/media.php
@@ -2528,7 +2528,7 @@ function media_upload_gallery_form( $errors ) {
  *
  * @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/src/wp-admin/includes/template.php b/src/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/src/wp-admin/install.php b/src/wp-admin/install.php
@@ -291,7 +291,7 @@ function display_setup_form( $error = null ) {
 
 /**
  * @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/src/wp-admin/options-general.php b/src/wp-admin/options-general.php
@@ -386,7 +386,7 @@
 <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/src/wp-admin/setup-config.php b/src/wp-admin/setup-config.php
@@ -88,7 +88,7 @@
  * @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/src/wp-includes/class-wp-locale-switcher.php b/src/wp-includes/class-wp-locale-switcher.php
@@ -213,7 +213,7 @@ private function load_translations( $locale ) {
 	 *
 	 * @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/src/wp-includes/customize/class-wp-customize-date-time-control.php b/src/wp-includes/customize/class-wp-customize-date-time-control.php
@@ -189,7 +189,7 @@ public function content_template() {
 	 * @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/src/wp-includes/functions.php b/src/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/src/wp-includes/general-template.php b/src/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/src/wp-includes/l10n.php b/src/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/src/wp-includes/load.php b/src/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/src/wp-includes/media.php b/src/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/src/wp-includes/script-loader.php b/src/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/src/wp-includes/theme.php b/src/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/src/wp-settings.php b/src/wp-settings.php
@@ -475,7 +475,7 @@
 /**
  * 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();

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ function export_add_js() {`
`128`	`128`	`* Create the date options fields for exporting a given post type.`
`129`	`129`	`*`
`130`	`130`	`* @global wpdb $wpdb WordPress database abstraction object.`
`131`		`- * @global WP_Locale $wp_locale Date and Time Locale object.`
	`131`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`132`	`132`	`*`
`133`	`133`	`* @since 3.1.0`
`134`	`134`	`*`
Original file line number	Diff line number	Diff line change
`@@ -536,7 +536,7 @@ protected function row_actions( $actions, $always_visible = false ) {`
`536`	`536`	`* @since 3.1.0`
`537`	`537`	`*`
`538`	`538`	`* @global wpdb $wpdb WordPress database abstraction object.`
`539`		`- * @global WP_Locale $wp_locale`
	`539`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`540`	`540`	`*`
`541`	`541`	`* @param string $post_type`
`542`	`542`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -2528,7 +2528,7 @@ function media_upload_gallery_form( $errors ) {`
`2528`	`2528`	`*`
`2529`	`2529`	`* @global wpdb $wpdb WordPress database abstraction object.`
`2530`	`2530`	`* @global WP_Query $wp_query`
`2531`		`- * @global WP_Locale $wp_locale`
	`2531`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`2532`	`2532`	`* @global string $type`
`2533`	`2533`	`* @global string $tab`
`2534`	`2534`	`* @global array $post_mime_types`
Original file line number	Diff line number	Diff line change
`@@ -757,7 +757,7 @@ function meta_form( $post = null ) {`
`757`	`757`	`* @since 0.71`
`758`	`758`	* @since 4.4.0 Converted to use get_comment() instead of the global `$comment`.
`759`	`759`	`*`
`760`		`- * @global WP_Locale $wp_locale`
	`760`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`761`	`761`	`*`
`762`	`762`	`* @param int\|bool $edit Accepts 1\|true for editing the date, 0\|false for adding the date.`
`763`	`763`	`* @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() {`
`1905`	`1905`	`*`
`1906`	`1906`	`* @global string $hook_suffix`
`1907`	`1907`	`* @global string $admin_body_class`
`1908`		`- * @global WP_Locale $wp_locale`
	`1908`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`1909`	`1909`	`*`
`1910`	`1910`	`* @param string $title Optional. Title of the Iframe page. Default empty.`
`1911`	`1911`	`* @param bool $deprecated Not used.`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@`
`88`	`88`	`* @since 2.3.0`
`89`	`89`	`*`
`90`	`90`	`* @global string $wp_local_package`
`91`		`- * @global WP_Locale $wp_locale`
	`91`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`92`	`92`	`*`
`93`	`93`	`* @param string\|array $body_classes`
`94`	`94`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ private function load_translations( $locale ) {`
`213`	`213`	`*`
`214`	`214`	`* @since 4.7.0`
`215`	`215`	`*`
`216`		`- * @global WP_Locale $wp_locale The WordPress date and time locale object.`
	`216`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`217`	`217`	`*`
`218`	`218`	`* @param string $locale The locale to change to.`
`219`	`219`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ public function content_template() {`
`189`	`189`	`* @since 4.9.0`
`190`	`190`	`* @see touch_time()`
`191`	`191`	`*`
`192`		`- * @global WP_Locale $wp_locale`
	`192`	`+ * @global WP_Locale $wp_locale WordPress date and time locale object.`
`193`	`193`	`*`
`194`	`194`	`* @return array`
`195`	`195`	`*/`