get_adjacent_post_rel_link( string $title = '%title', bool $in_same_term = false, int[]|string $excluded_terms = '', bool $previous = true, string $taxonomy = 'category' ): string|null

Description

Parameters

$titlestringoptional

Link title format. Default '%title'.Default: '%title'

$in_same_termbooloptional

Whether link should be in the same taxonomy term. Default false.Default: false

$excluded_termsint[]|stringoptional

Array or comma-separated list of excluded term IDs. Default empty.Default: ''

$previousbooloptional

Whether to display link to previous or next post. Default true.Default: true

$taxonomystringoptional

Taxonomy, if $in_same_term is true. Default 'category'.Default: 'category'

Return

string|null

The adjacent post relational link URL.

Hooks fired · 1

One hook fires while get_adjacent_post_rel_link() runs, in this order:

1. 1
   apply_filters( {$adjacent}_post_rel_link )filterline 2110 (+49 into the body)

   Filters the adjacent post relational link.

Uses · 10

• get_post()Retrieves post data given a post ID or post object.
• is_attachment()Determines whether the query is for an existing attachment page.
• get_adjacent_post()Retrieves the adjacent post.
• the_title_attribute()Sanitizes the current title when retrieving or displaying.
• __()Retrieves the translation of $text.
• mysql2date()Converts given MySQL date string into a different format.
• get_option()Retrieves an option value based on an option name.
• esc_attr()Escaping for HTML attributes.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• adjacent_posts_rel_link()Displays the relational links for the posts adjacent to the current post.
• next_post_rel_link()Displays the relational link for the next post adjacent to the current post.
• prev_post_rel_link()Displays the relational link for the previous post adjacent to the current post.

Source

View on Trac ↗View on GitHub ↗

2061function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {2062	$post = get_post();2063	if ( $previous && is_attachment() && $post ) {2064		$post = get_post( $post->post_parent );2065	} else {2066		$post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy );2067	}2068 2069	if ( empty( $post ) ) {2070		return null;2071	}2072 2073	$post_title = the_title_attribute(2074		array(2075			'echo' => false,2076			'post' => $post,2077		)2078	);2079 2080	if ( empty( $post_title ) ) {2081		$post_title = $previous ? __( 'Previous Post' ) : __( 'Next Post' );2082	}2083 2084	$date = mysql2date( get_option( 'date_format' ), $post->post_date );2085 2086	$title = str_replace( '%title', $post_title, $title );2087	$title = str_replace( '%date', $date, $title );2088 2089	$link  = $previous ? "<link rel='prev' title='" : "<link rel='next' title='";2090	$link .= esc_attr( $title );2091	$link .= "' href='" . get_permalink( $post ) . "' />\n";2092 2093	$adjacent = $previous ? 'previous' : 'next';2094 2095	/**2096	 * Filters the adjacent post relational link.2097	 *2098	 * The dynamic portion of the hook name, `$adjacent`, refers to the type2099	 * of adjacency, 'next' or 'previous'.2100	 *2101	 * Possible hook names include:2102	 *2103	 *  - `next_post_rel_link`2104	 *  - `previous_post_rel_link`2105	 *2106	 * @since 2.8.02107	 *2108	 * @param string $link The relational link.2109	 */2110	return apply_filters( "{$adjacent}_post_rel_link", $link );2111}

History

Introduced in 2.8.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.