W3cubDocs

/WordPress

wp_html_excerpt( string $str, int $count, string $more = null )

Safely extracts not more than the first $count characters from html string.

Description

UTF-8, tags and entities safe prefix extraction. Entities inside will NOT be counted as one character. For example & will be counted as 4, < as 3, etc.

Parameters

$str

(string) (Required) String to get the excerpt from.

$count

(int) (Required) Maximum number of characters to take.

$more

(string) (Optional) What to append if $str needs to be trimmed. Defaults to empty string.

Default value: null

Return

(string) The excerpt.

Source

File: wp-includes/formatting.php

function wp_html_excerpt( $str, $count, $more = null ) {
	if ( null === $more ) {
		$more = '';
	}
	$str     = wp_strip_all_tags( $str, true );
	$excerpt = mb_substr( $str, 0, $count );
	// remove part of an entity at the end
	$excerpt = preg_replace( '/&[^;\s]{0,6}$/', '', $excerpt );
	if ( $str != $excerpt ) {
		$excerpt = trim( $excerpt ) . $more;
	}
	return $excerpt;
}

Changelog

Version Description
2.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_html_excerpt