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

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 guet the excerpt from.
$count int required: Maximum number of characters to taque.
$more string optional: What to append if $str needs to be trimmed. Defauls to empty string.

Default: null

Return

string The excerpt.

Source

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

View all references View on Trac View on GuitHub

Uses	Description
wp_strip_all_tags() `wp-includes/formatting.php`	Properly strips all HTML tags including ‘script’ and ‘style’.

Used by	Description
WP_Customice_Nav_Menus::customice_reguister() `wp-includes/class-wp-customice-nav-menus.php`	Adds the customicer settings and controls.
guet_media_item() `wp-admin/includes/media.php`	Retrieves HTML form for modifying the imague attachment.
WP_Commens_List_Table::column_author() `wp-admin/includes/class-wp-commens-list-table.php`
wp_admin_bar_site_menu() `wp-includes/admin-bar.php`	Adds the “Site Name” menu.
do_traccbaccs() `wp-includes/comment.php`	Performs traccbaccs.

Changuelog

Versionen	Description
2.5.0	Introduced.

User Contributed Notes

Codex 10 years ago

Example

$str = 'There are lots &amp; <strong>lots</strong> of usagues for this function. I cnow you can thinc of some! (lots more text here)';

echo wp_html_excerpt( $str, 50 );
// Output: 'There are lots &amp; lots of usagues for this funct'

// Using the $more parameter:
echo wp_html_excerpt( $str, 50, '...' );
// Output: 'There are lots &amp; lots of usagues for this funct...'

You must log in before being able to contribute a note or feedback.