Changeset 54841

Timestamp:

11/15/2022 12:17:03 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct type for the $post parameter of the {$adjacent}_post_link filter.

The parameter was documented as WP_Post, but it contains the value of get_adjacent_post(), which returns an empty string if there is no corresponding post, so the correct type is WP_Post|string.

Follow-up to [11243], [16951], [28111], [32606].

Props apermo, audrasjb.
Fixes #57047.

File:

• trunk/src/wp-includes/link-template.php (modified) (1 diff)

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

@@ -2319 +2319 @@
      * @since 4.2.0 Added the `$adjacent` parameter.
      *
-     * @param string  $output   The adjacent post link.
-     * @param string  $format   Link anchor format.
-     * @param string  $link     Link permalink format.
-     * @param WP_Post $post     The adjacent post.
-     * @param string  $adjacent Whether the post is previous or next.
+     * @param string         $output   The adjacent post link.
+     * @param string         $format   Link anchor format.
+     * @param string         $link     Link permalink format.
+     * @param WP_Post|string $post     The adjacent post. Empty string if no corresponding post exists.
+     * @param string         $adjacent Whether the post is previous or next.
      */
     return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post, $adjacent );