1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
<?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' => '/<!--[\s\S]*?-->/',
'space_regexp' => '/ | /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 = isset( $attributes['averageReadingSpeed'] ) ? $attributes['averageReadingSpeed'] : 189;
$display_mode = isset( $attributes['displayMode'] ) ? $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' );
|
