Changeset 32538

Timestamp:

05/22/2015 04:13:35 AM (9 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to author-template.php.

See #32444.

File:

• trunk/src/wp-includes/author-template.php (modified) (8 diffs)

trunk/src/wp-includes/author-template.php

@@ -16 +16 @@
  * @since 1.5.0
  *
- * @uses $authordata The current author's DB object.
+ * @global object $authordata The current author's DB object.
  *
  * @param string $deprecated Deprecated.
@@ -104 +104 @@
  * @link https://codex.wordpress.org/Template_Tags/the_author_meta
  * @since 2.8.0
+ *
+ * @global object $authordata The current author's DB object.
+ *
  * @param string $field selects the field of the users record.
  * @param int $user_id Optional. User ID.
@@ -135 +138 @@
 
 /**
- * Retrieve the requested data of the author of the current post.
+ * Outputs the field from the user's DB object. Defaults to current post's author.
+ *
  * @link https://codex.wordpress.org/Template_Tags/the_author_meta
+ *
  * @since 2.8.0
+ *
  * @param string $field selects the field of the users record.
  * @param int $user_id Optional. User ID.
- * @echo string The author's field from the current author's DB object.
  */
 function the_author_meta( $field = '', $user_id = false ) {
@@ -223 +228 @@
  * @link https://codex.wordpress.org/Template_Tags/the_author_posts_link
  * @since 1.2.0
+ *
+ * @global object $authordata The current author's DB object.
+ *
  * @param string $deprecated Deprecated.
- *
- * @return false|null
  */
 function the_author_posts_link($deprecated = '') {
@@ -232 +238 @@
 
     global $authordata;
-    if ( !is_object( $authordata ) )
-        return false;
+    if ( ! is_object( $authordata ) ) {
+        return;
+    }
+
     $link = sprintf(
         '<a href="%1$s" title="%2$s" rel="author">%3$s</a>',
@@ -255 +263 @@
  *
  * @since 2.1.0
- * @uses $wp_rewrite WP_Rewrite
+ *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @return string The URL to the author's page.
  */
@@ -296 +306 @@
  *
  * @since 1.2.0
+ *
+ * @global wpdb $wpdb
  *
  * @param string|array $args {
@@ -428 +440 @@
  *
  * @since 3.2.0
+ *
+ * @global wpdb $wpdb
+ *
  * @return bool Whether or not we have more than one author
  */