Question

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.

---

参数

$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

---

返回值

(string) The excerpt.

---

源代码

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

---

更新日志

Version	description
2.5.0	Introduced.

---

相关函数

Uses

• wp-includes/formatting.php: wp_strip_all_tags()

---

Used By

• wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::customize_register()
• wp-admin/includes/media.php: get_media_item()
• 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()
• wp-includes/comment.php: do_trackbacks()

---

User Contributed Notes

1. Skip to note 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...'