Changeset 52111 for trunk/src/wp-includes/link-template.php

Timestamp:

11/10/2021 03:30:31 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: List the expected return type first in a few functions:

• get_previous_post()
• get_next_post()
• get_adjacent_post().

Follow-up to [46696], [47060], [49929], [49963], [51286].

See #53399.

File:

• trunk/src/wp-includes/link-template.php (modified) (3 diffs)

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

@@ -1740 +1740 @@
  * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
+ * @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
  *                             corresponding post exists.
  */
@@ -1755 +1755 @@
  * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
+ * @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
  *                             corresponding post exists.
  */
@@ -1775 +1775 @@
  * @param bool         $previous       Optional. Whether to retrieve previous post. Default true
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
+ * @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
  *                             corresponding post exists.
  */