WordPress.org

Make WordPress Core

Changeset 36500


Ignore:
Timestamp:
02/07/2016 08:08:48 AM (4 years ago)
Author:
DrewAPicture
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/functions.php

    r36417 r36500  
    15351535
    15361536/**
    1537  * Retrieve unvalidated referer from '_wp_http_referer' or HTTP referer.
    1538  *
    1539  * Do not use for redirects, use wp_get_referer() instead.
     1537 * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
     1538 *
     1539 * Do not use for redirects, use {@see wp_get_referer()} instead.
    15401540 *
    15411541 * @since 4.5.0
    15421542 *
    1543  * @return string|bool Referer URL on success, false on failure.
     1543 * @return string|false Referer URL on success, false on failure.
    15441544 */
    15451545function wp_get_raw_referer() {
Note: See TracChangeset for help on using the changeset viewer.