WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_html_excerpt()

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

In this article

Back to top

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

$strstringrequired
String to get the excerpt from.
$countintrequired
Maximum number of characters to take.
$morestringoptional
What to append if $str needs to be trimmed. Defaults 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 GitHub

UsesDescription
wp_strip_all_tags()wp-includes/formatting.php

Properly strips all HTML tags including ‘script’ and ‘style’.

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

Adds the customizer settings and controls.

get_media_item()wp-admin/includes/media.php

Retrieves HTML form for modifying the image attachment.

WP_Comments_List_Table::column_author()wp-admin/includes/class-wp-comments-list-table.php
wp_admin_bar_site_menu()wp-includes/admin-bar.php

Adds the “Site Name” menu.

do_trackbacks()wp-includes/comment.php

Performs trackbacks.

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    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

    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.