get_comments_pagination_arrow() – Function

Helper function that returns the proper pagination arrow HTML for CommentsPaginationNext and CommentsPaginationPrevious blocks based on the provided paginationArrow from CommentsPagination context.

Description

It’s used in CommentsPaginationNext and CommentsPaginationPrevious blocks.

Parameters

$blockWP_Blockrequired: Block instance.
$pagination_typestringoptional: Type of the arrow we will be rendering.
Accepts 'next' or 'previous'. Default 'next'.
Default:'next'

Return

string|null The pagination arrow HTML or null if there is none.

Source

function get_comments_pagination_arrow( $block, $pagination_type = 'next' ) {
	$arrow_map = array(
		'none'    => '',
		'arrow'   => array(
			'next'     => '→',
			'previous' => '←',
		),
		'chevron' => array(
			'next'     => '»',
			'previous' => '«',
		),
	);
	if ( ! empty( $block->context['comments/paginationArrow'] ) && ! empty( $arrow_map[ $block->context['comments/paginationArrow'] ][ $pagination_type ] ) ) {
		$arrow_attribute = $block->context['comments/paginationArrow'];
		$arrow           = $arrow_map[ $block->context['comments/paginationArrow'] ][ $pagination_type ];
		$arrow_classes   = "wp-block-comments-pagination-$pagination_type-arrow is-arrow-$arrow_attribute";
		return "<span class='$arrow_classes' aria-hidden='true'>$arrow</span>";
	}
	return null;
}

View all references View on Trac View on GitHub

Changelog

Version	Description
6.0.0	Introduced.

get_comments_pagination_arrow( WP_Block $block, string $pagination_type = ‘next’ ): string|null

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes