get_comments_pagination_arrow()WP 6.0.0

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

It's used in CommentsPaginationNext and CommentsPaginationPrevious blocks.

No Hooks.

Return

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

Usage

get_comments_pagination_arrow( $block, $pagination_type );
$block(WP_Block) (required)
Block instance.
$pagination_type(string)
Type of the arrow we will be rendering. Accepts 'next' or 'previous'.
Default: 'next'

Changelog

Since 6.0.0 Introduced.

Code of get_comments_pagination_arrow() WP 6.1.1

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;
}