wp_trim_excerpt()WP 1.5.0

Generates an excerpt from the content, if needed.

Returns a maximum of 55 words with an ellipsis appended if necessary.

The 55-word limit can be modified by plugins/themes using the excerpt_length filter The ' […]' string can be modified by plugins/themes using the excerpt_more filter

Return

String. The excerpt.

Usage

wp_trim_excerpt( $text, $post );
$text(string)
The excerpt. If set to empty, an excerpt is generated.
Default: ''
$post(WP_Post|object|int)
WP_Post instance or Post ID/object.
Default: null

Examples

0

#1 Demo

Suppose we have separate quotes for posts and we need to check if the post has such a quote, then we need to output it, and if it does not, then we need to output the trimmed text of the current post:

$excerpt = get_post_meta( $post->ID, 'special_excerpt', 1 );
$text = wp_trim_excerpt( $excerpt );

echo $text;
0

#2 Output a short text (excerpt) for the post

If we already have an excerpt and we just want to get short of it:

echo "Here is a short info about post: \n" . wp_trim_excerpt( $excerpt );

If there is no ready-made excerpt, you can pass the post ID, then the function will create it from the content:

echo "Here is a short info about post: \n" . wp_trim_excerpt( '', $post_id );

Changelog

Since 1.5.0 Introduced.
Since 5.2.0 Added the $post parameter.
Since 6.3.0 Removes footnotes markup from the excerpt content.

wp_trim_excerpt() code WP 6.5.4

function wp_trim_excerpt( $text = '', $post = null ) {
	$raw_excerpt = $text;

	if ( '' === trim( $text ) ) {
		$post = get_post( $post );
		$text = get_the_content( '', false, $post );

		$text = strip_shortcodes( $text );
		$text = excerpt_remove_blocks( $text );
		$text = excerpt_remove_footnotes( $text );

		/*
		 * Temporarily unhook wp_filter_content_tags() since any tags
		 * within the excerpt are stripped out. Modifying the tags here
		 * is wasteful and can lead to bugs in the image counting logic.
		 */
		$filter_image_removed = remove_filter( 'the_content', 'wp_filter_content_tags', 12 );

		/*
		 * Temporarily unhook do_blocks() since excerpt_remove_blocks( $text )
		 * handles block rendering needed for excerpt.
		 */
		$filter_block_removed = remove_filter( 'the_content', 'do_blocks', 9 );

		/** This filter is documented in wp-includes/post-template.php */
		$text = apply_filters( 'the_content', $text );
		$text = str_replace( ']]>', ']]>', $text );

		// Restore the original filter if removed.
		if ( $filter_block_removed ) {
			add_filter( 'the_content', 'do_blocks', 9 );
		}

		/*
		 * Only restore the filter callback if it was removed above. The logic
		 * to unhook and restore only applies on the default priority of 10,
		 * which is generally used for the filter callback in WordPress core.
		 */
		if ( $filter_image_removed ) {
			add_filter( 'the_content', 'wp_filter_content_tags', 12 );
		}

		/* translators: Maximum number of words used in a post excerpt. */
		$excerpt_length = (int) _x( '55', 'excerpt_length' );

		/**
		 * Filters the maximum number of words in a post excerpt.
		 *
		 * @since 2.7.0
		 *
		 * @param int $number The maximum number of words. Default 55.
		 */
		$excerpt_length = (int) apply_filters( 'excerpt_length', $excerpt_length );

		/**
		 * Filters the string in the "more" link displayed after a trimmed excerpt.
		 *
		 * @since 2.9.0
		 *
		 * @param string $more_string The string shown within the more link.
		 */
		$excerpt_more = apply_filters( 'excerpt_more', ' ' . '[…]' );
		$text         = wp_trim_words( $text, $excerpt_length, $excerpt_more );

	}

	/**
	 * Filters the trimmed excerpt string.
	 *
	 * @since 2.8.0
	 *
	 * @param string $text        The trimmed text.
	 * @param string $raw_excerpt The text prior to trimming.
	 */
	return apply_filters( 'wp_trim_excerpt', $text, $raw_excerpt );
}