get_the_excerpt

The WordPress Core get the excerpt hook.

Description

apply_filters( 'get_the_excerpt', (unknown) $post_post_excerpt, (unknown) $post ); 

Parameters (2)

0. $post_post_excerpt (unknown)
The post post excerpt.
1. $post (unknown)
The post.

Usage

To run the hook, copy the example below.
  1. $post_post_excerpt = apply_filters( 'get_the_excerpt', $post_post_excerpt, $post ); 
  2.  
  3. if ( !empty( $post_post_excerpt ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the get_the_excerpt callback 
  2. function filter_get_the_excerpt( $post_post_excerpt, $post ) { 
  3. // make filter magic happen here... 
  4. return $post_post_excerpt
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'get_the_excerpt', 'filter_get_the_excerpt', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'get_the_excerpt', 'filter_get_the_excerpt', 10, 2 ); 

Defined (3)

The filter is defined in the following location(s).

/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php  
  1. $excerpt = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) ); 
/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php  
  1. $caption = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) ); 
/wp-includes/post-template.php  
  1. return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );