wpseek.com
A WordPress-centric search engine for devs and theme authors



get_the_excerpt › WordPress Function

Since0.71
Deprecatedn/a
› get_the_excerpt ( $post = null )
Parameters:
  • (int|WP_Post) $post Optional. Post ID or WP_Post object. Default is global $post.
    Required: No
    Default: null
Returns:
  • (string) Post excerpt.
Defined at:
Codex:
Change Log:
  • 4.5.0

Retrieves the post excerpt.



Related Functions: the_excerpt, get_comment_excerpt, get_the_generator, the_excerpt_rss, get_the_terms

Source 

function get_the_excerpt( $post = null ) {
	if ( is_bool( $post ) ) {
		_deprecated_argument( __FUNCTION__, '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 1.2.0
	 * @since 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 );
}