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.

$comment_comment_content = apply_filters( 'get_comment_text', $comment_comment_content, $comment, $args ); 
                         
if ( !empty( $comment_comment_content ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the get_comment_text callback 
function filter_get_comment_text( $comment_comment_content, $comment, $args ) { 
    // make filter magic happen here... 
    return $comment_comment_content; 
}; 
         
// add the filter 
add_filter( 'get_comment_text', 'filter_get_comment_text', 10, 3 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'get_comment_text', 'filter_get_comment_text', 10, 3 );