Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use install_plugin_complete_actions filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read
Share Via:

install_plugin_complete_actions filter

Filters the list of action links available following a single plugin installation.

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

We at Flipper Code, 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 modify_install_plugin_complete_actions_defaults which takes 3 parameters and we registered using add_filter. The first parameter install_plugin_complete_actions is name of the hook, The second parameter modify_install_plugin_complete_actions_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove install_plugin_complete_actions filter.

Parameters

    Below are the 3 parameters are required to use this hook.

  • $install_actions : (string[]) Array of plugin action links.
  • $api : (object) Object containing WordPress.org API plugin data. Empty for non-API installs, such as when a plugin is installed via upload.
  • $plugin_file : (string) Path to the plugin file relative to the plugins directory.

Live Example

apply_filters( 'install_plugin_complete_actions', string[] $install_actions, object $api, string $plugin_file )

Below is an example how you can use this hook.

                        function modify_install_plugin_complete_actions_defaults($install_actions, $api, $plugin_file) { 
   
                            // 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_complete_actions", "modify_install_plugin_complete_actions_defaults", 10, 3 );

To remove a hook callback, use the example below.

remove_filter( "install_plugin_complete_actions", "modify_install_plugin_complete_actions_defaults", 10, 3 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.