Docs: Correct parameter types for the_author(), get_the_author_meta(), and the_author_meta().

SergeyBiryukov · SergeyBiryukov · commit fe0db882c523 · 2019-04-01T14:22:06.000Z
Props subrataemfluence. Fixes #45596. git-svn-id: https://develop.svn.wordpress.org/trunk@45086 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/author-template.php b/src/wp-includes/author-template.php
@@ -52,8 +52,8 @@ function get_the_author( $deprecated = '' ) {
  * @see get_the_author()
  * @link https://codex.wordpress.org/Template_Tags/the_author
  *
- * @param string $deprecated Deprecated.
- * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.
+ * @param string $deprecated      Deprecated.
+ * @param bool   $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.
  * @return string|null The author's display name, from get_the_author().
  */
 function the_author( $deprecated = '', $deprecated_echo = true ) {
@@ -153,8 +153,8 @@ function the_modified_author() {
  *
  * @global object $authordata The current author's DB object.
  *
- * @param string $field   Optional. The user field to retrieve. Default empty.
- * @param int    $user_id Optional. User ID.
+ * @param string    $field   Optional. The user field to retrieve. Default empty.
+ * @param int|false $user_id Optional. User ID.
  * @return string The author's field from the current author's DB object, otherwise an empty string.
  */
 function get_the_author_meta( $field = '', $user_id = false ) {
@@ -181,9 +181,9 @@ function get_the_author_meta( $field = '', $user_id = false ) {
 	 * @since 2.8.0
 	 * @since 4.3.0 The `$original_user_id` parameter was added.
 	 *
-	 * @param string   $value            The value of the metadata.
-	 * @param int      $user_id          The user ID for the value.
-	 * @param int|bool $original_user_id The original user ID, as passed to the function.
+	 * @param string    $value            The value of the metadata.
+	 * @param int       $user_id          The user ID for the value.
+	 * @param int|false $original_user_id The original user ID, as passed to the function.
 	 */
 	return apply_filters( "get_the_author_{$field}", $value, $user_id, $original_user_id );
 }
@@ -193,9 +193,9 @@ function get_the_author_meta( $field = '', $user_id = false ) {
  *
  * @since 2.8.0
  *
- * @param string $field   Selects the field of the users record. See get_the_author_meta()
- *                        for the list of possible fields.
- * @param int    $user_id Optional. User ID.
+ * @param string    $field   Selects the field of the users record. See get_the_author_meta()
+ *                           for the list of possible fields.
+ * @param int|false $user_id Optional. User ID.
  *
  * @see get_the_author_meta()
  */
@@ -209,8 +209,8 @@ function the_author_meta( $field = '', $user_id = false ) {
 	 *
 	 * @since 2.8.0
 	 *
-	 * @param string $author_meta The value of the metadata.
-	 * @param int    $user_id     The user ID.
+	 * @param string    $author_meta The value of the metadata.
+	 * @param int|false $user_id     The user ID.
 	 */
 	echo apply_filters( "the_author_{$field}", $author_meta, $user_id );
 }

Original file line number	Diff line number	Diff line change
`@@ -52,8 +52,8 @@ function get_the_author( $deprecated = '' ) {`
`52`	`52`	`* @see get_the_author()`
`53`	`53`	`* @link https://codex.wordpress.org/Template_Tags/the_author`
`54`	`54`	`*`
`55`		`- * @param string $deprecated Deprecated.`
`56`		`- * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.`
	`55`	`+ * @param string $deprecated Deprecated.`
	`56`	`+ * @param bool $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.`
`57`	`57`	`* @return string\|null The author's display name, from get_the_author().`
`58`	`58`	`*/`
`59`	`59`	`function the_author( $deprecated = '', $deprecated_echo = true ) {`
`@@ -153,8 +153,8 @@ function the_modified_author() {`
`153`	`153`	`*`
`154`	`154`	`* @global object $authordata The current author's DB object.`
`155`	`155`	`*`
`156`		`- * @param string $field Optional. The user field to retrieve. Default empty.`
`157`		`- * @param int $user_id Optional. User ID.`
	`156`	`+ * @param string $field Optional. The user field to retrieve. Default empty.`
	`157`	`+ * @param int\|false $user_id Optional. User ID.`
`158`	`158`	`* @return string The author's field from the current author's DB object, otherwise an empty string.`
`159`	`159`	`*/`
`160`	`160`	`function get_the_author_meta( $field = '', $user_id = false ) {`
`@@ -181,9 +181,9 @@ function get_the_author_meta( $field = '', $user_id = false ) {`
`181`	`181`	`* @since 2.8.0`
`182`	`182`	* @since 4.3.0 The `$original_user_id` parameter was added.
`183`	`183`	`*`
`184`		`- * @param string $value The value of the metadata.`
`185`		`- * @param int $user_id The user ID for the value.`
`186`		`- * @param int\|bool $original_user_id The original user ID, as passed to the function.`
	`184`	`+ * @param string $value The value of the metadata.`
	`185`	`+ * @param int $user_id The user ID for the value.`
	`186`	`+ * @param int\|false $original_user_id The original user ID, as passed to the function.`
`187`	`187`	`*/`
`188`	`188`	`return apply_filters( "get_the_author_{$field}", $value, $user_id, $original_user_id );`
`189`	`189`	`}`
`@@ -193,9 +193,9 @@ function get_the_author_meta( $field = '', $user_id = false ) {`
`193`	`193`	`*`
`194`	`194`	`* @since 2.8.0`
`195`	`195`	`*`
`196`		`- * @param string $field Selects the field of the users record. See get_the_author_meta()`
`197`		`- * for the list of possible fields.`
`198`		`- * @param int $user_id Optional. User ID.`
	`196`	`+ * @param string $field Selects the field of the users record. See get_the_author_meta()`
	`197`	`+ * for the list of possible fields.`
	`198`	`+ * @param int\|false $user_id Optional. User ID.`
`199`	`199`	`*`
`200`	`200`	`* @see get_the_author_meta()`
`201`	`201`	`*/`
`@@ -209,8 +209,8 @@ function the_author_meta( $field = '', $user_id = false ) {`
`209`	`209`	`*`
`210`	`210`	`* @since 2.8.0`
`211`	`211`	`*`
`212`		`- * @param string $author_meta The value of the metadata.`
`213`		`- * @param int $user_id The user ID.`
	`212`	`+ * @param string $author_meta The value of the metadata.`
	`213`	`+ * @param int\|false $user_id The user ID.`
`214`	`214`	`*/`
`215`	`215`	`echo apply_filters( "the_author_{$field}", $author_meta, $user_id );`
`216`	`216`	`}`