How to use admin_post_action action in WordPress

admin_post_action action

The dynamic portion of the hook name, $action, refers to the given request action.

To use admin_post_action 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 execute_on_admin_post_action_event and registered it using add_action. The first parameter admin_post_action is the name of the hook, the second parameter execute_on_admin_post_action_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 admin_post_action action.

Parameters

• No parameters

Live Example 1: Registering the Hook

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

    add_action('admin_post_add_foobar', 'weplugins_admin_add_foobar');
    function weplugins_admin_add_foobar() {
        // Handle request then generate response using echo or leaving PHP and using HTML
    }
    

Live Example 2: Using the Hook

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

    function weplugins_execute_on_admin_post_action_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("admin_post_action", "weplugins_execute_on_admin_post_action_event");
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_action("admin_post_action", "weplugins_execute_on_admin_post_action_event");
    

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 us and we’d be happy to assist you.