apply_filters( 'get_the_excerpt', string $post_excerpt , WP_Post $post )
Filters the retrieved post excerpt.
Parameters
-
$post_excerpt
string -
The post excerpt.
-
$post
WP_Post -
Post object.
More Information
The get_the_excerpt
filter is used to filter the excerpt of the post after it is retrieved from the database and before it is returned from the get_the_excerpt() function.
When the get_the_excerpt
filter is called, the filter function is passed a single argument containing the post excerpt.
function filter_function_name( $excerpt ) {
# ...
}
add_filter( 'get_the_excerpt', 'filter_function_name' );
Where ‘filter_function_name
‘ is the function WordPress should call when the excerpt is being retrieved. Note that the filter function must return the excerpt after it is finished processing, or page sections showing an excerpt will be blank, and other plugins also filtering the excerpt may generate errors.
The ‘filter_function_name
‘ should be a unique function name. It cannot match any other function name already declared.
Source
File: wp-includes/post-template.php
.
View all references
return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
Changelog
Version | Description |
---|---|
4.5.0 | Introduced the $post parameter. |
1.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
When using this filter on a string stored in a variable, the string will not be trimmed by the
excerpt_length
filter.This is expected behaviour. By passing a long string through the
get_the_excerpt
filter, you are simulating the case where you have entered the same long text into theExcerpt
field in theEdit Post
screen. When a custom excerpt is present on the post, no trimming is done (though other content filters are applied).If you want to simulate the automatic excerpt trimming on arbitrary text, you can pass the text to
wp_trim_words()
yourself, with a function like this:The function above can be used like this:
Examples migrated from Codex:
Custom “More” Link
This example from the twentyeleven theme appends a custom “Read more” link to post excerpts. See has_excerpt() and is_attachment().
Fallback excerpt for posts with AUTOMATED excerpt: