Bamboo Panda

✏️ Editing: post-time-to-read.php

<?php
/**
 * Server-side rendering of the `core/post-time-to-read` block.
 *
 * @package WordPress
 */

/**
 * Counts words or characters in a provided text string.
 *
 * This function currently employs an array of regular expressions
 * to parse HTML and count words, which may result in inaccurate
 * word counts. However, it is designed primarily to agree with the
 * corresponding JavaScript function.
 *
 * Any improvements in the word counting, for example with the HTML API
 * and {@see \IntlBreakIterator::createWordInstance()} should coordinate
 * with changes to the JavaScript implementation to ensure consistency
 * between the editor and the rendered page.
 *
 * @since 6.9.0
 *
 * @param string $text Text to count elements in.
 * @param string $type The type of count. Accepts 'words', 'characters_excluding_spaces', or 'characters_including_spaces'.
 *
 * @return string The rendered word count.
 */
function block_core_post_time_to_read_word_count( $text, $type ) {
	$settings = array(
		'html_regexp'                        => '/<\/?[a-z][^>]*?>/i',
		'html_comment_regexp'                => '//',
		'space_regexp'                       => '/&nbsp;|&#160;/i',
		'html_entity_regexp'                 => '/&\S+?;/',
		'connector_regexp'                   => "/--|\x{2014}/u",
		'remove_regexp'                      => "/[\x{0021}-\x{0040}\x{005B}-\x{0060}\x{007B}-\x{007E}\x{0080}-\x{00BF}\x{00D7}\x{00F7}\x{2000}-\x{2BFF}\x{2E00}-\x{2E7F}]/u",
		'astral_regexp'                      => "/[\x{010000}-\x{10FFFF}]/u",
		'words_regexp'                       => '/\S\s+/u',
		'characters_excluding_spaces_regexp' => '/\S/u',
		'characters_including_spaces_regexp' => "/[^\f\n\r\t\v\x{00AD}\x{2028}\x{2029}]/u",
	);

$count = 0;

if ( '' === trim( $text ) ) {
		return $count;
	}

// Sanitize type to one of three possibilities: 'words', 'characters_excluding_spaces' or 'characters_including_spaces'.
	if ( 'characters_excluding_spaces' !== $type && 'characters_including_spaces' !== $type ) {
		$type = 'words';
	}

$text .= "\n";

// Replace all HTML with a new-line.
	$text = preg_replace( $settings['html_regexp'], "\n", $text );

// Remove all HTML comments.
	$text = preg_replace( $settings['html_comment_regexp'], '', $text );

// If a shortcode regular expression has been provided use it to remove shortcodes.
	if ( ! empty( $settings['shortcodes_regexp'] ) ) {
		$text = preg_replace( $settings['shortcodes_regexp'], "\n", $text );
	}

// Normalize non-breaking space to a normal space.
	$text = preg_replace( $settings['space_regexp'], ' ', $text );

if ( 'words' === $type ) {
		// Remove HTML Entities.
		$text = preg_replace( $settings['html_entity_regexp'], '', $text );

// Convert connectors to spaces to count attached text as words.
		$text = preg_replace( $settings['connector_regexp'], ' ', $text );

// Remove unwanted characters.
		$text = preg_replace( $settings['remove_regexp'], '', $text );
	} else {
		// Convert HTML Entities to "a".
		$text = preg_replace( $settings['html_entity_regexp'], 'a', $text );

// Remove surrogate points.
		$text = preg_replace( $settings['astral_regexp'], 'a', $text );
	}

// Match with the selected type regular expression to count the items.
	return (int) preg_match_all( $settings[ $type . '_regexp' ], $text );
}

/**
 * Renders the `core/post-time-to-read` block on the server.
 *
 * @since 6.9.0
 *
 * @param  array    $attributes Block attributes.
 * @param  string   $content    Block default content.
 * @param  WP_Block $block      Block instance.
 * @return string Returns the rendered post author name block.
 */
function render_block_core_post_time_to_read( $attributes, $content, $block ) {
	if ( ! isset( $block->context['postId'] ) ) {
		return '';
	}

$content              = get_the_content();
	$average_reading_rate = $attributes['averageReadingSpeed'] ?? 189;

$display_mode = $attributes['displayMode'] ?? 'time';

$word_count_type = wp_get_word_count_type();
	$total_words     = block_core_post_time_to_read_word_count( $content, $word_count_type );

$parts = array();

// Add "time to read" part, if enabled.
	if ( 'time' === $display_mode ) {
		if ( ! empty( $attributes['displayAsRange'] ) ) {
			// Calculate faster reading rate with 20% speed = lower minutes,
			// and slower reading rate with 20% speed = higher minutes.
			$min_minutes = max( 1, (int) round( $total_words / $average_reading_rate * 0.8 ) );
			$max_minutes = max( 1, (int) round( $total_words / $average_reading_rate * 1.2 ) );
			if ( $min_minutes === $max_minutes ) {
				$max_minutes = $min_minutes + 1;
			}
			/* translators: 1: minimum minutes, 2: maximum minutes to read the post. */
			$time_string = sprintf(
				/* translators: 1: minimum minutes, 2: maximum minutes to read the post. */
				_x( '%1$s–%2$s minutes', 'Range of minutes to read' ),
				$min_minutes,
				$max_minutes
			);
		} else {
			$minutes_to_read = max( 1, (int) round( $total_words / $average_reading_rate ) );
			$time_string     = sprintf(
				/* translators: %s: the number of minutes to read the post. */
				_n( '%s minute', '%s minutes', $minutes_to_read ),
				$minutes_to_read
			);
		}
		$parts[] = $time_string;
	}

// Add "word count" part, if enabled.
	if ( 'words' === $display_mode ) {
		$word_count_string = 'words' === $word_count_type ? sprintf(
			/* translators: %s: the number of words in the post. */
			_n( '%s word', '%s words', $total_words ),
			number_format_i18n( $total_words )
		) : sprintf(
			/* translators: %s: the number of characters in the post. */
			_n( '%s character', '%s characters', $total_words ),
			number_format_i18n( $total_words )
		);
		$parts[] = $word_count_string;
	}

$display_string = implode( '<br>', $parts );

$align_class_name = empty( $attributes['textAlign'] ) ? '' : "has-text-align-{$attributes['textAlign']}";

$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $align_class_name ) );

return sprintf(
		'<div %1$s>%2$s</div>',
		$wrapper_attributes,
		$display_string
	);
}

/**
 * Registers the `core/post-time-to-read` block on the server.
 *
 * @since 6.9.0
 */
function register_block_core_post_time_to_read() {
	register_block_type_from_metadata(
		__DIR__ . '/post-time-to-read',
		array(
			'render_callback' => 'render_block_core_post_time_to_read',
		)
	);
}

add_action( 'init', 'register_block_core_post_time_to_read' );

T	Name	Size
📁	..	-
📁	accordion	-
📁	accordion-heading	-
📁	accordion-item	-
📁	accordion-panel	-
📁	archives	-
📁	audio	-
📁	avatar	-
📁	block	-
📁	breadcrumbs	-
📁	button	-
📁	buttons	-
📁	calendar	-
📁	categories	-
📁	code	-
📁	column	-
📁	columns	-
📁	comment-author-name	-
📁	comment-content	-
📁	comment-date	-
📁	comment-edit-link	-
📁	comment-reply-link	-
📁	comment-template	-
📁	comments	-
📁	comments-pagination	-
📁	comments-pagination-next	-
📁	comments-pagination-numbers	-
📁	comments-pagination-previous	-
📁	comments-title	-
📁	cover	-
📁	details	-
📁	embed	-
📁	file	-
📁	footnotes	-
📁	freeform	-
📁	gallery	-
📁	group	-
📁	heading	-
📁	home-link	-
📁	html	-
📁	icon	-
📁	image	-
📁	latest-comments	-
📁	latest-posts	-
📁	legacy-widget	-
📁	list	-
📁	list-item	-
📁	loginout	-
📁	math	-
📁	media-text	-
📁	missing	-
📁	more	-
📁	navigation	-
📁	navigation-link	-
📁	navigation-overlay-close	-
📁	navigation-submenu	-
📁	nextpage	-
📁	page-list	-
📁	page-list-item	-
📁	paragraph	-
📁	pattern	-
📁	playlist	-
📁	playlist-track	-
📁	post-author	-
📁	post-author-biography	-
📁	post-author-name	-
📁	post-comments-count	-
📁	post-comments-form	-
📁	post-comments-link	-
📁	post-content	-
📁	post-date	-
📁	post-excerpt	-
📁	post-featured-image	-
📁	post-navigation-link	-
📁	post-template	-
📁	post-terms	-
📁	post-time-to-read	-
📁	post-title	-
📁	preformatted	-
📁	pullquote	-
📁	query	-
📁	query-no-results	-
📁	query-pagination	-
📁	query-pagination-next	-
📁	query-pagination-numbers	-
📁	query-pagination-previous	-
📁	query-title	-
📁	query-total	-
📁	quote	-
📁	read-more	-
📁	rss	-
📁	search	-
📁	separator	-
📁	shortcode	-
📁	site-logo	-
📁	site-tagline	-
📁	site-title	-
📁	social-link	-
📁	social-links	-
📁	spacer	-
📁	tab-list	-
📁	tab-panel	-
📁	tab-panels	-
📁	table	-
📁	tabs	-
📁	tag-cloud	-
📁	template-part	-
📁	term-count	-
📁	term-description	-
📁	term-name	-
📁	term-template	-
📁	terms-query	-
📁	text-columns	-
📁	verse	-
📁	video	-
📁	widget-group	-
📄	.blocks.php	0.00 B
📄	accordion-item.php	2.98 KB
📄	accordion.php	1.12 KB
📄	archives.php	4.28 KB
📄	avatar.php	5.51 KB
📄	block.php	3.05 KB
📄	blocks-json.php	205.72 KB
📄	breadcrumbs.php	18.61 KB
📄	button.php	4.11 KB
📄	calendar.php	5.93 KB
📄	categories.php	4.82 KB
📄	comment-author-name.php	2.09 KB
📄	comment-content.php	2.40 KB
📄	comment-date.php	1.82 KB
📄	comment-edit-link.php	1.67 KB
📄	comment-reply-link.php	2.03 KB
📄	comment-template.php	4.39 KB
📄	comments-pagination-next.php	1.88 KB
📄	comments-pagination-numbers.php	1.59 KB
📄	comments-pagination-previous.php	1.75 KB
📄	comments-pagination.php	1.23 KB
📄	comments-title.php	2.72 KB
📄	comments.php	6.63 KB
📄	cover.php	7.23 KB
📄	details.php	1.46 KB
📄	file.php	1.83 KB
📄	footnotes.php	3.73 KB
📄	gallery.php	21.82 KB
📄	heading.php	1.27 KB
📄	home-link.php	4.59 KB
📄	icon.php	4.27 KB
📄	image.php	17.23 KB
📄	index.php	4.98 KB
📄	latest-comments.php	5.49 KB
📄	latest-posts.php	10.21 KB
📄	legacy-widget.php	3.92 KB
📄	list.php	1.24 KB
📄	loginout.php	2.07 KB
📄	media-text.php	4.20 KB
📄	navigation-link.php	16.26 KB
📄	navigation-overlay-close.php	1.72 KB
📄	navigation-submenu.php	10.79 KB
📄	navigation.php	69.23 KB
📄	page-list-item.php	361.00 B
📄	page-list.php	13.54 KB
📄	paragraph.php	1.11 KB
📄	pattern.php	1.75 KB
📄	playlist-track.php	2.43 KB
📄	playlist.php	6.46 KB
📄	post-author-biography.php	1.49 KB
📄	post-author-name.php	1.92 KB
📄	post-author.php	2.67 KB
📄	post-comments-count.php	1.25 KB
📄	post-comments-form.php	2.74 KB
📄	post-comments-link.php	2.18 KB
📄	post-content.php	2.61 KB
📄	post-date.php	3.61 KB
📄	post-excerpt.php	4.21 KB
📄	post-featured-image.php	9.23 KB
📄	post-navigation-link.php	4.69 KB
📄	post-template.php	5.80 KB
📄	post-terms.php	3.55 KB
📄	post-time-to-read.php	6.26 KB
📄	post-title.php	2.09 KB
📄	query-no-results.php	1.80 KB
📄	query-pagination-next.php	3.59 KB
📄	query-pagination-numbers.php	4.59 KB
📄	query-pagination-previous.php	3.39 KB
📄	query-pagination.php	1.15 KB
📄	query-title.php	2.71 KB
📄	query-total.php	2.41 KB
📄	query.php	5.56 KB
📄	read-more.php	1.80 KB
📄	require-dynamic-blocks.php	5.13 KB
📄	require-static-blocks.php	535.00 B
📄	rss.php	4.50 KB
📄	search.php	25.00 KB
📄	shortcode.php	735.00 B
📄	site-logo.php	6.19 KB
📄	site-tagline.php	1.17 KB
📄	site-title.php	1.82 KB
📄	social-link.php	66.02 KB
📄	tab-list.php	2.27 KB
📄	tab-panel.php	1.63 KB
📄	tabs.php	3.86 KB
📄	tag-cloud.php	1.55 KB
📄	template-part.php	9.73 KB
📄	term-count.php	1.80 KB
📄	term-description.php	1.73 KB
📄	term-name.php	1.99 KB
📄	term-template.php	4.41 KB
📄	video.php	2.67 KB
📄	widget-group.php	2.38 KB