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

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

Description
Parameters
Return
Source
Changelog
User Contributed Notes

Description

It’s used in CommentsPaginationNext and CommentsPaginationPrevious blocks.

Top ↑

Parameters

$block WP_Block Required: Block instance.
$pagination_type string Optional: Type of the arrow we will be rendering.
Accepts 'next' or 'previous'. Default 'next'.

Default: 'next'

Top ↑

Return

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

Top ↑

Source

File: wp-includes/blocks.php. View all references

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 on Trac View on GitHub

Top ↑