previous_image_link( string|int[] $size = 'thumbnail', string|false $text = false )
Displays previous image link that has the same post parent.
Parameters
-
$sizestring|int[] Optional -
Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default
'thumbnail'.Default:
'thumbnail' -
$textstring|false Optional -
Link text.
Default:
false
More Information
Usage:
Typically uses in attachment.php. In the WordPress default theme Twenty Eleven and Twenty Twelve, it is used in image.php.
previous_image_link( $size, $text );Notes:
This creates a link to the previous image attached to the current post. Whenever a series of images are linked to the attachment page, it will put a ‘previous image link’ with the images when viewed in the attachment page.
Source
File: wp-includes/media.php.
View all references
function previous_image_link( $size = 'thumbnail', $text = false ) {
echo get_previous_image_link( $size, $text );
}
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Examples
Default Usage
Working example
Choose a Recognized Image Size
Define a Custom Image Size
Please note that passing an array as the first parameter will not create a new image; It will use the web browser to re-size the thumbnail to fit into the given dimensions. Although this works in a pinch, it produces a rather distorted view of the image due to the fact that browsers have no way of re sampling the re-sized image.
Use the Image’s Title as Link Text
If a Boolean false is used as the first parameter, The function will use the image’s title value (as set through the Media Library).
Use a Custom String as Link Text
To specify a custom string as the link text, pass a Boolean false as the first parameter and the custom text as a string to the second parameter.