WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Revisions_Controller::prepare_excerpt_response()

WP_REST_Revisions_Controller::prepare_excerpt_response( string $excerpt, WP_Post $post ): string

In this article

Back to top

Checks the post excerpt and prepare it for single post output.

Parameters

$excerptstringrequired
The post excerpt.
$postWP_Postrequired
Post revision object.

Return

string Prepared excerpt or empty string.

Source

protected function prepare_excerpt_response( $excerpt, $post ) {

	/** This filter is documented in wp-includes/post-template.php */
	$excerpt = apply_filters( 'the_excerpt', $excerpt, $post );

	if ( empty( $excerpt ) ) {
		return '';
	}

	return $excerpt;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘the_excerpt’, string $post_excerpt )

Filters the displayed post excerpt.

UsesDescription
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Used byDescription
WP_REST_Revisions_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Prepares the revision for the REST response.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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