the_excerpt

Filter Hook

Description

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

Hook Information

File Location	`wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php` View on GitHub
Hook Type	Filter
Line Number	`881`

Hook Parameters

Type	Name	Description
`string`	`$excerpt`	The post excerpt.
`WP_Post`	`$post`	Post revision object.

Usage Examples

Basic Usage

<?php
// Hook into the_excerpt
add_filter('the_excerpt', 'my_custom_filter', 10, 2);

function my_custom_filter($excerpt, $post) {
    // Your custom filtering logic here
    return $excerpt;
}

Source Code Context

wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php:881 - How this hook is used in WordPress core

<?php
 876  	 * @return string Prepared excerpt or empty string.
 877  	 */
 878  	protected function prepare_excerpt_response( $excerpt, $post ) {
 879  
 880  		/** This filter is documented in wp-includes/post-template.php */
 881  		$excerpt = apply_filters( 'the_excerpt', $excerpt, $post );
 882  
 883  		if ( empty( $excerpt ) ) {
 884  			return '';
 885  		}
 886

PHP Documentation

<?php
/**
	 * Checks the post excerpt and prepare it for single post output.
	 *
	 * @since 4.7.0
	 *
	 * @param string  $excerpt The post excerpt.
	 * @param WP_Post $post    Post revision object.
	 * @return string Prepared excerpt or empty string.
	 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.