render_block_core_post_excerpt( array $attributes, string $content, WP_Block $block ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attributesarray

Block attributes.

$contentstring

Block default content.

$blockWP_Block

Block instance.

Return value

string

Returns the filtered post excerpt for the current post wrapped inside "p" tags.

Performance profile

How much work a call to render_block_core_post_excerpt() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

5

Executed per call on PHP 8.5. The body compiles to 118.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below render_block_core_post_excerpt()
• querycontent queryget_post()one call below render_block_core_post_excerpt()
• optionoption read or writeget_option()one call below render_block_core_post_excerpt()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost render_block_core_post_excerpt() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• esc_url()Checks and cleans a URL.
• get_the_permalink()Retrieves the full permalink for the current post or post ID.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• add_filter()Adds a callback function to a filter hook.
• get_the_excerpt()Retrieves the post excerpt.
• remove_filter()Removes a callback function from a filter hook.
• wp_trim_words()Trims text to a certain number of words.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.

Source code

View on Trac ↗View on GitHub ↗

18function render_block_core_post_excerpt( $attributes, $content, $block ) {19	if ( ! isset( $block->context['postId'] ) ) {20		return '';21	}22 23	$more_text           = ! empty( $attributes['moreText'] ) ? '<a class="wp-block-post-excerpt__more-link" href="' . esc_url( get_the_permalink( $block->context['postId'] ) ) . '">' . wp_kses_post( $attributes['moreText'] ) . '</a>' : '';24	$filter_excerpt_more = static function ( $more ) use ( $more_text ) {25		return empty( $more_text ) ? $more : '';26	};27	/**28	 * Some themes might use `excerpt_more` filter to handle the29	 * `more` link displayed after a trimmed excerpt. Since the30	 * block has a `more text` attribute we have to check and31	 * override if needed the return value from this filter.32	 * So if the block's attribute is not empty override the33	 * `excerpt_more` filter and return nothing. This will34	 * result in showing only one `read more` link at a time.35	 *36	 * This hook needs to be applied before the excerpt is retrieved with get_the_excerpt.37	 * Otherwise, the read more link filter from the theme is not removed.38	 */39	add_filter( 'excerpt_more', $filter_excerpt_more );40 41	/*42	 * The purpose of the excerpt length setting is to limit the length of both43	 * automatically generated and user-created excerpts.44	 * Because the excerpt_length filter only applies to auto generated excerpts,45	 * wp_trim_words is used instead.46	 *47	 * To ensure the block's excerptLength setting works correctly for auto-generated48	 * excerpts, we temporarily override excerpt_length to 101 (the max block setting)49	 * so that wp_trim_excerpt doesn't pre-trim the content before wp_trim_words can50	 * apply the user's desired length.51	 */52	$excerpt_length = $attributes['excerptLength'];53	add_filter( 'excerpt_length', 'block_core_post_excerpt_excerpt_length', PHP_INT_MAX );54 55	$excerpt = get_the_excerpt( $block->context['postId'] );56 57	remove_filter( 'excerpt_length', 'block_core_post_excerpt_excerpt_length', PHP_INT_MAX );58 59	if ( isset( $excerpt_length ) ) {60		$excerpt = wp_trim_words( $excerpt, $excerpt_length );61	}62 63	$classes = array();64	if ( isset( $attributes['textAlign'] ) ) {65		$classes[] = 'has-text-align-' . $attributes['textAlign'];66	}67	if ( isset( $attributes['style']['elements']['link']['color']['text'] ) ) {68		$classes[] = 'has-link-color';69	}70	$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => implode( ' ', $classes ) ) );71 72	$content               = '<p class="wp-block-post-excerpt__excerpt">' . $excerpt;73	$show_more_on_new_line = ! isset( $attributes['showMoreOnNewLine'] ) || $attributes['showMoreOnNewLine'];74	if ( $show_more_on_new_line && ! empty( $more_text ) ) {75		$content .= '</p><p class="wp-block-post-excerpt__more-text">' . $more_text . '</p>';76	} else {77		$content .= " $more_text</p>";78	}79	remove_filter( 'excerpt_more', $filter_excerpt_more );80	return sprintf( '<div %1$s>%2$s</div>', $wrapper_attributes, $content );81}

Changelog

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks/post-excerpt.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.