How to use admin_page_access_denied action in WordPress

admin_page_access_denied action

Fires when access to an admin page is denied.

To use admin_page_access_denied 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_page_access_denied_event and we registered it using add_action. The first parameter admin_page_access_denied is the name of the hook, the second parameter execute_on_admin_page_access_denied_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_page_access_denied action.

Parameters

• No parameters

Live Example

Example 1: Redirecting on Access Denied

This example shows how to redirect users to the home page when access to an admin page is denied.

function weplugins_permission_error() {
   wp_redirect( site_url() );
   exit;
}
add_action( 'admin_page_access_denied', 'weplugins_permission_error');

Example 2: Custom Function Execution

Below is an example of how you can use this hook to execute a custom function when access to an admin page is denied.

function weplugins_execute_on_admin_page_access_denied_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_page_access_denied', 'weplugins_execute_on_admin_page_access_denied_event');

Example 3: Removing a Hook

To remove a hook callback, use the example below.

remove_action( 'admin_page_access_denied', 'weplugins_execute_on_admin_page_access_denied_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 or need customization, please contact us and we’d be happy to assist you.