wp_trim_excerpt( string $text = , WP_Post|object|int $post = null ): string

Generates an excerpt from the content, if needed.

Description

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

Parameters

$textstringoptional
The excerpt. If set to empty, an excerpt is generated.

Default:''

$postWP_Post|object|intoptional
WP_Post instance or Post ID/object.

Default:null

Return

string The excerpt.

Source

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

Hooks

apply_filters( ‘excerpt_length’, int $number )

Filters the maximum number of words in a post excerpt.

apply_filters( ‘excerpt_more’, string $more_string )

Filters the string in the “more” link displayed after a trimmed excerpt.

apply_filters( ‘the_content’, string $content )

Filters the post content.

apply_filters( ‘wp_trim_excerpt’, string $text, string $raw_excerpt )

Filters the trimmed excerpt string.

Changelog

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

User Contributed Notes

  1. Skip to note 2 content

    If we had excerpt already and just want to trim it into smaller amount, use this:

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

    and if not, you just need to use code like this, note the $id is id of the post

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

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