How to use plugin_install_action_links filter in WordPress

plugin_install_action_links filter

Filters the install action links for a plugin.

To use plugin_install_action_links 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.

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_modify_plugin_install_action_links_defaults which takes 2 parameters and we registered using add_filter. The first parameter plugin_install_action_links is the name of the hook, the second parameter weplugins_modify_plugin_install_action_links_defaults 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_filter to remove plugin_install_action_links filter.

Parameters

Below are the 2 parameters required to use this hook.

• $action_links : (string[]) An array of plugin action links. Defaults are links to Details and Install Now.
• $plugin : (array) An array of plugin data. See plugins_api() for the list of possible values.

Live Example

apply_filters( 'plugin_install_action_links', string[] $action_links, array $plugin )

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

Example 1: Modify Plugin Install Action Links

This example demonstrates how to modify the default plugin install action links.

    function weplugins_modify_plugin_install_action_links_defaults($action_links, $plugin) { 
        // Update the $action_links variable according to your website requirements and return this variable.
        // You can modify the $action_links variable conditionally too if you want.
        return $action_links; 
    }
    // add the filter
    add_filter( "plugin_install_action_links", "weplugins_modify_plugin_install_action_links_defaults", 10, 2 );
    

Example 2: Remove Plugin Install Action Links Filter

To remove a hook callback, use the example below.

    remove_filter( "plugin_install_action_links", "weplugins_modify_plugin_install_action_links_defaults", 10, 2 );
    

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

Example 3: Conditional Modification of Action Links

This example shows how to conditionally modify the plugin install action links based on the plugin data.

    function weplugins_conditional_modify_plugin_install_action_links($action_links, $plugin) {
        if ($plugin['slug'] == 'specific-plugin') {
            // Modify $action_links specifically for 'specific-plugin'
            $action_links[] = '<a href="#">Custom Link</a>';
        }
        return $action_links;
    }
    // add the filter
    add_filter("plugin_install_action_links", "weplugins_conditional_modify_plugin_install_action_links", 10, 2);
    

Contact Us

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