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

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

Contents

Description 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 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

Top ↑

Return Return

(string) The excerpt.

Top ↑

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

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::customize_register()

Add the customizer settings and controls.
wp-admin/includes/media.php: get_media_item()

Retrieve HTML form for modifying the image attachment.
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::column_author()
wp-includes/admin-bar.php: wp_admin_bar_site_menu()

Add the “Site Name” menu.
wp-includes/comment.php: do_trackbacks()

Perform trackbacks.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

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

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

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

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