How to use install_plugin_overwrite_actions filter in WordPress

install_plugin_overwrite_actions filter

Filters the list of action links available following a single plugin installation failure when overwriting is allowed. To use install_plugin_overwrite_actions 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.

At WePlugins, we 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_modify_install_plugin_overwrite_actions_defaults which takes 3 parameters and we registered using add_filter. The first parameter install_plugin_overwrite_actions is the name of the hook, the second parameter weplugins_modify_install_plugin_overwrite_actions_defaults is the name of the function that 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 install_plugin_overwrite_actions filter.

Parameters

Below are the 3 parameters required to use this hook.

• $install_actions: (string[]) Array of plugin action links.
• $api: (object) Object containing WordPress.org API plugin data.
• $new_plugin_data: (array) Array with uploaded plugin data.

Live Example 1: Basic Usage

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

    function weplugins_modify_install_plugin_overwrite_actions_defaults($install_actions, $api, $new_plugin_data) { 
        // Update the $install_actions variable according to your website requirements and return this variable. You can modify the $install_actions variable conditionally too if you want.
        return $install_actions; 
    }
    // add the filter
    add_filter( "install_plugin_overwrite_actions", "weplugins_modify_install_plugin_overwrite_actions_defaults", 10, 3 );
    

Live Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "install_plugin_overwrite_actions", "weplugins_modify_install_plugin_overwrite_actions_defaults", 10, 3 );
    

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

Live Example 3: Custom Action Links

Here’s how you can customize action links based on your requirements.

    function weplugins_custom_install_plugin_actions($install_actions, $api, $new_plugin_data) {
        // Add a custom action link
        $install_actions['custom-action'] = '<a href="#">Custom Action</a>';
        return $install_actions;
    }
    add_filter( "install_plugin_overwrite_actions", "weplugins_custom_install_plugin_actions", 10, 3 );
    

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.