How to use clear_auth_cookie action in WordPress

clear_auth_cookie action

Fires just before the authentication cookies are cleared.

To use the clear_auth_cookie action, first you have to register it using add_action. 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 weplugins_execute_on_clear_auth_cookie_event and we registered it using add_action. The first parameter clear_auth_cookie is the name of the hook, the second parameter weplugins_execute_on_clear_auth_cookie_event 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_action to remove the clear_auth_cookie action.

Parameters

• No parameters

Live Example 1

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

    function weplugins_execute_on_clear_auth_cookie_event() {
        // You can write code here to be executed when this action occurs in WordPress website according to your requirements.
    }
    // add the action
    add_action( "clear_auth_cookie", "weplugins_execute_on_clear_auth_cookie_event");
    

Live Example 2

To remove a hook callback, use the example below.

    remove_action( "clear_auth_cookie", "weplugins_execute_on_clear_auth_cookie_event");
    

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

Live Example 3

Here is another example showing how to log a message when the authentication cookies are cleared.

    function weplugins_log_clear_auth_cookie_event() {
        error_log("Authentication cookies have been cleared.");
    }
    // add the action
    add_action( "clear_auth_cookie", "weplugins_log_clear_auth_cookie_event");
    

Contact Us

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