get_adjacent_post_rel_link

Advertisement

Summery Summery

Retrieves the adjacent post relational link.

Syntax Syntax

get_adjacent_post_rel_link( string $title = '%title', bool $in_same_term = false, array|string $excluded_terms = '', bool $previous = true, string $taxonomy = 'category' )

Description Description

Can either be next or previous post relational link.

Parameters Parameters

$title

(Optional) Link title format. Default '%title'.

Default value: '%title'

$in_same_term

(Optional) Whether link should be in a same taxonomy term.

Default value: false

$excluded_terms

(Optional) Array or comma-separated list of excluded term IDs.

Default value: ''

$previous

(Optional) Whether to display link to previous or next post.

Default value: true

$taxonomy

(Optional) Taxonomy, if $in_same_term is true. Default 'category'.

Default value: 'category'

Return Return

(string|void) The adjacent post relational link URL.

Source Source

File: wp-includes/link-template.php

function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
	$post = get_post();
	if ( $previous && is_attachment() && $post ) {
		$post = get_post( $post->post_parent );
	} else {
		$post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy );
	}

	if ( empty( $post ) ) {
		return;
	}

	$post_title = the_title_attribute(
		array(
			'echo' => false,
			'post' => $post,
		)
	);

	if ( empty( $post_title ) ) {
		$post_title = $previous ? __( 'Previous Post' ) : __( 'Next Post' );
	}

	$date = mysql2date( get_option( 'date_format' ), $post->post_date );

	$title = str_replace( '%title', $post_title, $title );
	$title = str_replace( '%date', $date, $title );

	$link  = $previous ? "<link rel='prev' title='" : "<link rel='next' title='";
	$link .= esc_attr( $title );
	$link .= "' href='" . get_permalink( $post ) . "' />\n";

	$adjacent = $previous ? 'previous' : 'next';

	/**
	 * Filters the adjacent post relational link.
	 *
	 * The dynamic portion of the hook name, `$adjacent`, refers to the type
	 * of adjacency, 'next' or 'previous'.
	 *
	 * @since 2.8.0
	 *
	 * @param string $link The relational link.
	 */
	return apply_filters( "{$adjacent}_post_rel_link", $link );
}

Advertisement

Changelog Changelog

Changelog
Version Description
2.8.0 Introduced.

Advertisement

Leave a Reply