W3cubDocs

/WordPress

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

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

$text

(string) (Optional) The excerpt. If set to empty, an excerpt is generated.

Default value: ''

$post

(WP_Post|object|int) (Optional) WP_Post instance or Post ID/object.

Default value: null

Return

(string) The excerpt.

Source

File: wp-includes/formatting.php

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

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

		/* translators: Maximum number of words used in a post excerpt. */
		$excerpt_length = intval( _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', ' ' . '[&hellip;]' );
		$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 );
}

Uses

Uses	Description
wp-includes/blocks.php: excerpt_remove_blocks()	Parses blocks out of a content string, and renders those appropriate for the excerpt.
wp-includes/l10n.php: _x()	Retrieve translated string with gettext context.
wp-includes/formatting.php: wp_trim_words()	Trims text to a certain number of words.
wp-includes/formatting.php: excerpt_length	Filters the maximum number of words in a post excerpt.
wp-includes/formatting.php: excerpt_more	Filters the string in the “more” link displayed after a trimmed excerpt.
wp-includes/formatting.php: wp_trim_excerpt	Filters the trimmed excerpt string.
wp-includes/shortcodes.php: strip_shortcodes()	Remove all shortcode tags from the given content.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/post-template.php: get_the_content()	Retrieve the post content.
wp-includes/post-template.php: the_content	Filters the post content.
wp-includes/post.php: get_post()	Retrieves post data given a post ID or post object.

Changelog

Version	Description
5.2.0	Added the `$post` parameter.
1.5.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_trim_excerpt