Changeset 32526

Timestamp:

05/21/2015 08:09:44 PM (10 years ago)

Author:

wonderboymusic

Message:

In author-template.php, clarify/add some return docs.

See #32444.

File:

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

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

@@ -19 +19 @@
  *
  * @param string $deprecated Deprecated.
- * @return string The author's display name.
+ * @return string|null The author's display name.
  */
 function get_the_author($deprecated = '') {
@@ -54 +54 @@
  * @param string $deprecated Deprecated.
  * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.
- * @return string The author's display name, from get_the_author().
+ * @return string|null The author's display name, from get_the_author().
  */
 function the_author( $deprecated = '', $deprecated_echo = true ) {
@@ -71 +71 @@
  * @since 2.8.0
  *
- * @return string The author's display name.
+ * @return string|null The author's display name.
  */
 function get_the_modified_author() {
@@ -89 +89 @@
 
 /**
- * Display the name of the author who last edited the current post.
+ * Display the name of the author who last edited the current post,
+ * if the author's ID is available.
  *
  * @since 2.8.0
  *
  * @see get_the_author()
- * @return string The author's display name, from get_the_modified_author().
  */
 function the_modified_author() {
@@ -163 +163 @@
  * If the author has a home page set, return an HTML link, otherwise just return the
  * author's name.
+ *
+ * @return string|null An HTML link if the author's url exist in user meta,
+ *                     else the result of get_the_author().
  */
 function get_the_author_link() {
@@ -221 +224 @@
  * @since 1.2.0
  * @param string $deprecated Deprecated.
+ *
+ * @return false|null
  */
 function the_author_posts_link($deprecated = '') {