previous_post_link │ filter-hook │ WP 2.6.0

Filters the adjacent post link.

Usage

add_filter( 'previous_post_link', 'wp_kama_previous_post_link_filter', 10, 5 );

/**
 * Function for `previous_post_link` filter-hook.
 * 
 * @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 string
 */
function wp_kama_previous_post_link_filter( $output, $format, $link, $post, $adjacent ){

	// filter...
	return $output;
}

$output(string)

The adjacent post link.

$format(string)

Link anchor format.

$link(string)

Link permalink format.

$post(WP_Post|string)

The adjacent post. Empty string if no corresponding post exists.

$adjacent(string)

Whether the post is previous or next.

Changelog

Where the hook is called

return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post, $adjacent );

Where the hook is used in WordPress