wp_trim_words( string $text, int $num_words = 55, string $more = null ): string

Trims text to a certain number of words.


Description

This function is localized. For languages that count ‘words’ by the individual character (such as East Asian languages), the $num_words argument will apply to the number of individual characters.


Top ↑

Parameters

$text string Required
Text to trim.
$num_words int Optional
Number of words.

Default: 55

$more string Optional
What to append if $text needs to be trimmed. Default '…'.

Default: null


Top ↑

Return

string Trimmed text.


Top ↑

Source

File: wp-includes/formatting.php. View all references

function wp_trim_words( $text, $num_words = 55, $more = null ) {
	if ( null === $more ) {
		$more = __( '…' );
	}

	$original_text = $text;
	$text          = wp_strip_all_tags( $text );
	$num_words     = (int) $num_words;

	/*
	 * translators: If your word count is based on single characters (e.g. East Asian characters),
	 * enter 'characters_excluding_spaces' or 'characters_including_spaces'. Otherwise, enter 'words'.
	 * Do not translate into your own language.
	 */
	if ( strpos( _x( 'words', 'Word count type. Do not translate!' ), 'characters' ) === 0 && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
		$text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
		preg_match_all( '/./u', $text, $words_array );
		$words_array = array_slice( $words_array[0], 0, $num_words + 1 );
		$sep         = '';
	} else {
		$words_array = preg_split( "/[\n\r\t ]+/", $text, $num_words + 1, PREG_SPLIT_NO_EMPTY );
		$sep         = ' ';
	}

	if ( count( $words_array ) > $num_words ) {
		array_pop( $words_array );
		$text = implode( $sep, $words_array );
		$text = $text . $more;
	} else {
		$text = implode( $sep, $words_array );
	}

	/**
	 * Filters the text content after words have been trimmed.
	 *
	 * @since 3.3.0
	 *
	 * @param string $text          The trimmed text.
	 * @param int    $num_words     The number of words to trim the text to. Default 55.
	 * @param string $more          An optional string to append to the end of the trimmed text, e.g. ….
	 * @param string $original_text The text before it was trimmed.
	 */
	return apply_filters( 'wp_trim_words', $text, $num_words, $more, $original_text );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
3.3.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 4 content
    Contributed by tripflex

    If for some reason you need the words that were trimmed, here’s a modified version of this function, to return the words before AND after in an array:

    if( ! function_exists( 'smyles_wp_split_words' ) ){
    	/**
    	 * Split a string based on word count
    	 *
    	 * This is similar to WordPress wp_trim_words function, but instead of just trimming after a certain amount of
    	 * words, this function returns an array with 'before' and 'after' keys -- providing you the string of text up
    	 * to the number of words (in before key), and the words after (in the after key).  After key will be empty string
    	 * if there are less words in the passed string than number of words to split on.
    	 *
    	 *
    	 * @param string    $text
    	 * @param int       $num_words
    	 *
    	 * @return array    Array with `before` and `after` keys. The `before` key contains all words up to $num_words, the
    	 *                  `after` key contains the words after $num_words (or empty string if passed string has less words
    	 *                  than passed in $text)
    	 *
    	 */
    	function smyles_wp_split_words( $text, $num_words = 55 ) {
    		$text = wp_strip_all_tags( $text );
    		/*
    		 * translators: If your word count is based on single characters (e.g. East Asian characters),
    		 * enter 'characters_excluding_spaces' or 'characters_including_spaces'. Otherwise, enter 'words'.
    		 * Do not translate into your own language.
    		 */
    		if ( strpos( _x( 'words', 'Word count type. Do not translate!' ), 'characters' ) === 0 && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
    			$text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
    			preg_match_all( '/./u', $text, $words_array_matches );
    			$words_array = $words_array_matches[0];
    			$sep         = '';
    		} else {
    			$words_array = preg_split( "/[\n\r\t ]+/", $text, -1, PREG_SPLIT_NO_EMPTY );
    			$sep         = ' ';
    		}
    		if ( count( $words_array ) > $num_words ) {
    			$before = implode( $sep, array_slice( $words_array, 0, $num_words ) );
    			$after  = implode( $sep, array_slice( $words_array, $num_words, count( $words_array ) - 1 ) );
    		} else {
    			$before = implode( $sep, $words_array );
    		}
    		$results = array(
    			'before' => $before,
    			'after' => isset( $after ) ? $after : ''
    		);
    		return $results;
    	}
    }

    https://gist.github.com/tripflex/5ccb97ac0b76d355bceff5111803d7ea

  2. Skip to note 5 content
    Contributed by Jb Audras

    Example: display comment excerpt in a comments custom query.

    $args = array(
    	'number' => 3,
    );
    $comments_query = new WP_Comment_Query;
    $comments = $comments_query->query( $args );
    if ( $comments ) {
    	foreach ( $comments as $comment ) {
    		echo wp_trim_words( $comment->comment_content, 20, ' […]' );
    	}
    }

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