Changeset 36500

Timestamp:

02/07/2016 08:08:48 AM (9 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:

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

trunk/src/wp-includes/functions.php

@@ -1535 +1535 @@
 
 /**
- * Retrieve unvalidated referer from '_wp_http_referer' or HTTP referer.
- *
- * Do not use for redirects, use wp_get_referer() instead.
+ * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
+ *
+ * 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() {