How to use post_comments_link filter in WordPress

post_comments_link filter

Filters the formatted post comments link HTML.

apply_filters('post_comments_link', string $formatted, int|WP_Post $post)

Description

This hook is used for filtering the HTML of a post comments link which can be retrieved using the get_post_reply_link() hook for a post.

Parameters

• $formatted: (string) The HTML-formatted post comments link.
• $post: (int|WP_Post) The post ID or WP_Post object.

Live Example

To run the hook, copy the example below.

Example 1: Basic Usage

In this example, we are applying the post_comments_link filter to a formatted post comments link.

    $formatted_link = apply_filters('post_comments_link', $formatted_link, $post);

    if (!empty($formatted_link)) {
        // everything has led up to this point...
    }
    

Example 2: Adding a Hook Callback

This example demonstrates how to add a callback function to the post_comments_link filter.

    // define the post_comments_link callback
    function weplugins_filter_post_comments_link($formatted_link, $post) {
        // make filter magic happen here...
        return $formatted_link;
    }

    // add the filter
    add_filter('post_comments_link', 'weplugins_filter_post_comments_link', 10, 2);
    

Example 3: Removing a Hook Callback

If you need to remove a previously added callback function from the post_comments_link filter, use the following example.

    // remove the filter
    remove_filter('post_comments_link', 'weplugins_filter_post_comments_link', 10, 2);
    

Contact Us

If you need customization or have any questions, feel free to contact us.