Changeset 34484

Timestamp:

09/24/2015 05:49:07 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Fix the summary for get_locale().

Also update the description to properly link up hook references with inline @see tags.

See #32246.

File:

• trunk/src/wp-includes/l10n.php (modified) (1 diff)

trunk/src/wp-includes/l10n.php

@@ -9 +9 @@
 
 /**
- * Get the current locale.
- *
- * If the locale is set, then it will filter the locale in the 'locale' filter
- * hook and return the value.
+ * Retrieves the current locale.
+ *
+ * If the locale is set, then it will filter the locale in the {@see 'locale'}
+ * filter hook and return the value.
  *
  * If the locale is not set already, then the WPLANG constant is used if it is
- * defined. Then it is filtered through the 'locale' filter hook and the value
- * for the locale global set and the locale is returned.
+ * defined. Then it is filtered through the {@see 'locale'} filter hook and
+ * the value for the locale global set and the locale is returned.
  *
  * The process to get the locale should only be done once, but the locale will
- * always be filtered using the 'locale' hook.
+ * always be filtered using the {@see 'locale'} hook.
  *
  * @since 1.5.0