Changeset 51122

Timestamp:

06/08/2021 11:12:22 PM (4 years ago)

Author:

whyisjake

Message:

Media: Add new functions to return the previous/next attachment links.

New functions:

• get_adjacent_image_link()
• get_next_image_link()
• get_previous_image_link()

Fixes #45708.

Props flixos90, DrewAPicture, mor10, antpb, hellofromTonya, whyisjake.

Location:

trunk

Files:

• phpcs.xml.dist (modified) (1 diff)
• src/wp-includes/media.php (modified) (4 diffs)
• tests/phpunit/tests/media/getAdjacentImageLink.php (added)
• tests/phpunit/tests/media/getNextImageLink.php (added)
• tests/phpunit/tests/media/getPreviousImageLink.php (added)
• tests/phpunit/tests/media/nextImageLink.php (added)
• tests/phpunit/tests/media/previousImageLink.php (added)
• tests/phpunit/tests/media/testcase-adjacent-image-link.php (added)

trunk/phpcs.xml.dist

@@ -250 +250 @@
                 <element value="Tests_Query_Conditionals"/>
                 <element value="WP_Test_XML_TestCase"/>
+                <element value="WP_Test_Adjacent_Image_Link_TestCase"/>
 
                 <!-- Mock classes. -->

trunk/src/wp-includes/media.php

@@ -3378 +3378 @@
 
 /**
- * Displays previous image link that has the same post parent.
- *
- * @since 2.5.0
- *
- * @see adjacent_image_link()
+ * Gets the previous image link that has the same post parent.
+ *
+ * @since 5.8.0
+ *
+ * @see get_adjacent_image_link()
  *
  * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
  *                           of width and height values in pixels (in that order). Default 'thumbnail'.
  * @param string|false $text Optional. Link text. Default false.
- */
-function previous_image_link( $size = 'thumbnail', $text = false ) {
-    adjacent_image_link( true, $size, $text );
-}
-
-/**
- * Displays next image link that has the same post parent.
+ * @return string Markup for previous image link.
+ */
+function get_previous_image_link( $size = 'thumbnail', $text = false ) {
+    return get_adjacent_image_link( true, $size, $text );
+}
+
+/**
+ * Displays previous image link that has the same post parent.
  *
  * @since 2.5.0
- *
- * @see adjacent_image_link()
  *
  * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
@@ -3403 +3402 @@
  * @param string|false $text Optional. Link text. Default false.
  */
+function previous_image_link( $size = 'thumbnail', $text = false ) {
+    echo get_previous_image_link( $size, $text );
+}
+
+/**
+ * Gets the next image link that has the same post parent.
+ *
+ * @since 5.8.0
+ *
+ * @see get_adjacent_image_link()
+ *
+ * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
+ *                           of width and height values in pixels (in that order). Default 'thumbnail'.
+ * @param string|false $text Optional. Link text. Default false.
+ * @return string Markup for next image link.
+ */
+function get_next_image_link( $size = 'thumbnail', $text = false ) {
+    return get_adjacent_image_link( false, $size, $text );
+}
+
+/**
+ * Displays next image link that has the same post parent.
+ *
+ * @since 2.5.0
+ *
+ * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
+ *                           of width and height values in pixels (in that order). Default 'thumbnail'.
+ * @param string|false $text Optional. Link text. Default false.
+ */
 function next_image_link( $size = 'thumbnail', $text = false ) {
-    adjacent_image_link( false, $size, $text );
-}
-
-/**
- * Displays next or previous image link that has the same post parent.
+    echo get_next_image_link( $size, $text );
+}
+
+/**
+ * Gets the next or previous image link that has the same post parent.
  *
  * Retrieves the current attachment object from the $post global.
  *
- * @since 2.5.0
+ * @since 5.8.0
  *
  * @param bool         $prev Optional. Whether to display the next (false) or previous (true) link. Default true.
@@ -3418 +3446 @@
  *                           of width and height values in pixels (in that order). Default 'thumbnail'.
  * @param bool         $text Optional. Link text. Default false.
- */
-function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
+ * @return string Markup for image link.
+ */
+function get_adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
     $post        = get_post();
     $attachments = array_values(
@@ -3474 +3503 @@
      * @param string $text          Link text.
      */
-    echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
+    return apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
+}
+
+/**
+ * Displays next or previous image link that has the same post parent.
+ *
+ * Retrieves the current attachment object from the $post global.
+ *
+ * @since 2.5.0
+ *
+ * @param bool         $prev Optional. Whether to display the next (false) or previous (true) link. Default true.
+ * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
+ *                           of width and height values in pixels (in that order). Default 'thumbnail'.
+ * @param bool         $text Optional. Link text. Default false.
+ */
+function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
+    echo get_adjacent_image_link( $prev, $size, $text );
 }