wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_trim_words › WordPress Function

Since3.3.0
Deprecatedn/a
› wp_trim_words ( $text, $num_words = 55, $more = null )
Parameters: (3)
  • (string) $text Text to trim.
    Required: Yes
  • (int) $num_words Number of words. Default 55.
    Required: No
    Default: 55
  • (string) $more Optional. What to append if $text needs to be trimmed. Default '…'.
    Required: No
    Default: null
Returns:
  • (string) Trimmed text.
Defined at:
Codex:

Trims text to a certain number of words.

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.


Related Functions: wp_trim_excerpt, wp_title_rss, wp_set_password, wp_write_post, wp_trigger_error

Source 

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;

	if ( str_starts_with( wp_get_word_count_type(), 'characters' ) && 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 );
}