How to use load-page_hook action in WordPress

load-page_hook action

The load-* hook fires in a number of contexts. This hook is for plugin screens where a callback is provided when the screen is registered. To use load-page_hook 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.

WePlugins always prefers 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_load-page_hook_event and registered it using add_action. The first parameter load-page_hook is the name of the hook, the second parameter execute_on_load-page_hook_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 load-page_hook action.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_load_page_hook_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("load-page_hook", "weplugins_execute_on_load_page_hook_event");
    

Live Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_action("load-page_hook", "weplugins_execute_on_load_page_hook_event");
    

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

Live Example 3: Dynamic Page Hook

Using dynamic page hooks can be beneficial in certain scenarios.

    $page_hook = 'my_custom_page';
    do_action("load-{$page_hook}");
    

Contact Us

If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.