get_comment_text

Filters the text of a comment.

Description

apply_filters( 'get_comment_text', (string) $comment_comment_content, (WP_Comment) $comment, (array) $args ); 

Parameters (3)

0. $comment_comment_content (string)
The comment comment content.
1. $comment (WP_Comment)
The comment object.
2. $args (array)
An array of arguments.

Usage

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

Defined (1)

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

/wp-includes/comment-template.php  
  1. return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );