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.

Built from https://develop.svn.wordpress.org/trunk@36500


git-svn-id: http://core.svn.wordpress.org/trunk@36467 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-02-07 08:09:25 +00:00
parent b45a6228d0
commit 48988c505f
2 changed files with 4 additions and 4 deletions

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 * @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() { function wp_get_raw_referer() {
if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) { if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-36499'; $wp_version = '4.5-alpha-36500';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.