Docs: Make a couple of minor improvements to the DocBlock for wp_get_raw_referer(), introduced in [36266].

* Uses a third-person singular verb in the summary
* Makes the return types more specific with `string|false` vs `string|bool`.

See #27152. See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36500 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-02-07 08:08:48 +00:00
parent 46029e674a
commit 1c80e8ca46

View File

@ -1534,13 +1534,13 @@ function wp_get_referer() {
}
/**
* Retrieve unvalidated referer from '_wp_http_referer' or HTTP referer.
* Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
*
* Do not use for redirects, use wp_get_referer() instead.
* Do not use for redirects, use {@see wp_get_referer()} instead.
*
* @since 4.5.0
*
* @return string|bool Referer URL on success, false on failure.
* @return string|false Referer URL on success, false on failure.
*/
function wp_get_raw_referer() {
if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {