get_the_excerpt( int|WP_Post $post = null )
Retrieves the post excerpt.
Parameters
- $post
-
(Optional) Post ID or WP_Post object. Default is global $post.
Default value: null
Return
(string) Post excerpt.
Source
File: wp-includes/post-template.php
function get_the_excerpt( $post = null ) {
if ( is_bool( $post ) ) {
_deprecated_argument( __FUNCTION__, 'WP-2.3.0' );
}
$post = get_post( $post );
if ( empty( $post ) ) {
return '';
}
if ( post_password_required( $post ) ) {
return __( 'There is no excerpt because this is a protected post.' );
}
/**
* Filters the retrieved post excerpt.
*
* @since WP-1.2.0
* @since WP-4.5.0 Introduced the `$post` parameter.
*
* @param string $post_excerpt The post excerpt.
* @param WP_Post $post Post object.
*/
return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
}
Changelog
Version | Description |
---|---|
WP-4.5.0 | Introduced the $post parameter. |
WP-0.71 | Introduced. |