How to use comment_status_links filter in WordPress

comment_status_links filter

Filters the comment status links.

To use the comment_status_links filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_comment_status_links_defaults which takes 1 parameter and we registered using add_filter. The first parameter comment_status_links is the name of the hook. The second parameter weplugins_modify_comment_status_links_defaults is the name of the function which needs to be called. The third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the comment_status_links filter.

Parameters

Below the 1 parameter is required to use this hook.

• $status_links: (string[]) An associative array of fully-formed comment status links. Includes ‘All’, ‘Mine’, ‘Pending’, ‘Approved’, ‘Spam’, and ‘Trash’.

Live Example

apply_filters( 'comment_status_links', string[] $status_links )

Below is an example of how you can use this hook.

Example 1: Modify Comment Status Links

This example shows how to modify the comment status links.

  function weplugins_modify_comment_status_links_defaults($status_links) { 
      // Update the $status_links variable according to your website requirements and return this variable. You can modify the $status_links variable conditionally too if you want.
      return $status_links; 
  }
  // add the filter
  add_filter( "comment_status_links", "weplugins_modify_comment_status_links_defaults", 10, 1 );
  

Example 2: Add Custom Comment Status Link

In this example, we add a custom comment status link.

  function weplugins_add_custom_comment_status_link($status_links) { 
      $status_links['custom'] = '<a href="#">Custom</a>';
      return $status_links; 
  }
  // add the filter
  add_filter( "comment_status_links", "weplugins_add_custom_comment_status_link", 10, 1 );
  

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

  remove_filter( "comment_status_links", "weplugins_modify_comment_status_links_defaults", 10, 1 );
  

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.