get_comments_link

Filters the returned post comments permalink.

Description

apply_filters( 'get_comments_link', (string) $comments_link, (int|WP_Post) $post_id ); 

Parameters (2)

0. $comments_link (string)
Post comments permalink with #comments appended.
1. $post_id (int|WP_Post)
Post ID or WP_Post object.

Usage

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

Defined (1)

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

/wp-includes/comment-template.php  
  1. return apply_filters( 'get_comments_link', $comments_link, $post_id );