Changeset 36705

Timestamp:

02/25/2016 05:06:39 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Make a few syntactical improvements to the DocBlock for _wp_get_current_user(), introduced in [36651].

Includes a cross reference from the DocBlock for wp_get_current_user(), which itself is pluggable, but the new internal function is not.

See #19615. See #32246.

Location:

trunk/src/wp-includes

Files:

• pluggable.php (modified) (1 diff)
• user.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -61 +61 @@
  * @since 2.0.3
  *
+ * @see _wp_get_current_user()
  * @global WP_User $current_user Checks if the current user is set.
  *

trunk/src/wp-includes/user.php

@@ -2409 +2409 @@
 
 /**
- * Retrieve the current user object.
+ * Retrieves the current user object.
  *
  * Will set the current user, if the current user is not set. The current user
@@ -2415 +2415 @@
  * set the current user to 0, which is invalid and won't have any permissions.
  *
- * This function is used by the pluggable functions {@see wp_get_current_user()}
- * and {@see get_currentuserinfo()}, which is deprecated, for backward compatibility.
+ * This function is used by the pluggable functions wp_get_current_user() and
+ * get_currentuserinfo(), which is deprecated, for backward compatibility.
  *
  * @since 4.5.0
  * @access private
  *
- * @see https://core.trac.wordpress.org/ticket/19615
+ * @see wp_get_current_user()
  * @global WP_User $current_user Checks if the current user is set.
  *