Changeset 55398 for trunk/src/wp-includes/author-template.php

Timestamp:

02/21/2023 04:37:03 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document default values for optional parameters in various DocBlocks.

Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.

File:

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

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

@@ -156 +156 @@
  *
  * @param string    $field   Optional. The user field to retrieve. Default empty.
- * @param int|false $user_id Optional. User ID.
+ * @param int|false $user_id Optional. User ID. Defaults to the current post author.
  * @return string The author's field from the current author's DB object, otherwise an empty string.
  */
@@ -197 +197 @@
  * @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.
+ * @param int|false $user_id Optional. User ID. Defaults to the current post author.
  *
  * @see get_the_author_meta()