Docs: Fix the summary for get_locale().

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

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34484 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-24 05:49:07 +00:00
parent f85670cd36
commit b91804e0bf

View File

@ -8,17 +8,17 @@
*/
/**
* Get the current locale.
* Retrieves the current locale.
*
* If the locale is set, then it will filter the locale in the 'locale' filter
* hook and return the value.
* 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
*