How to use comment_post_redirect filter in WordPress

comment_post_redirect filter

Filters the location URI to send the commenter after posting.

To use the comment_post_redirect 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.

We at 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 modify_comment_post_redirect_defaults which takes 2 parameters and we registered using add_filter. The first parameter comment_post_redirect is the name of the hook, the second parameter modify_comment_post_redirect_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_post_redirect filter.

Parameters

Below are the 2 parameters required to use this hook.

• $location: (string) The ‘redirect_to’ URI sent via $_POST.
• $comment: (WP_Comment) Comment object.

Live Example 1: Redirect Comment to a Custom Post Type

In this example, we will redirect comments to a custom post type.

	add_filter( 'comment_post_redirect', 'weplugins_redirect_comments', 10, 2 );
	function weplugins_redirect_comments( $location, $commentdata ) {
		if (!isset($commentdata) || empty($commentdata->comment_post_ID)) {
			return $location;
		}
		$post_id = $commentdata->comment_post_ID;
		if ('my-custom-post' == get_post_type($post_id)) {
			return wp_get_referer() . "#comment-" . $commentdata->comment_ID;
		}
		return $location;
	}
	

Live Example 2: Modify Comment Post Redirect Defaults

Below is an example of how you can use this hook to modify the default redirect location for comments.

	function weplugins_modify_comment_post_redirect_defaults($location, $comment) {
		// Update the $location variable according to your website requirements and return this variable. You can modify the $location variable conditionally too if you want.
		return $location;
	}
	// add the filter
	add_filter("comment_post_redirect", "weplugins_modify_comment_post_redirect_defaults", 10, 2);
	

Live Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

	remove_filter("comment_post_redirect", "weplugins_modify_comment_post_redirect_defaults", 10, 2);
	

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

Contact Us

If you’re having any trouble using this hook, please contact our team and we’d be happy to assist you.