How to use install_theme_complete_actions filter in WordPress

install_theme_complete_actions filter

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

To use the install_theme_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 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_install_theme_complete_actions_defaults which takes 4 parameters and we registered using add_filter. The first parameter install_theme_complete_actions is the name of the hook, the second parameter weplugins_modify_install_theme_complete_actions_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 the install_theme_complete_actions filter.

Parameters

Below are the 4 parameters required to use this hook.

• $install_actions: (string[]) Array of theme action links.
• $api: (object) Object containing WordPress.org API theme data.
• $stylesheet: (string) Theme directory name.
• $theme_info: (WP_Theme) Theme object.

Live Examples

Example 1: Basic Usage

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

    function weplugins_modify_install_theme_complete_actions_defaults($install_actions, $api, $stylesheet, $theme_info) { 
        // 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_theme_complete_actions", "weplugins_modify_install_theme_complete_actions_defaults", 10, 4);
    

Example 2: Conditional Modification

This example shows how to modify the $install_actions variable conditionally.

    function weplugins_conditional_install_theme_complete_actions($install_actions, $api, $stylesheet, $theme_info) {
        if ($stylesheet === 'my-custom-theme') {
            // Custom action link for 'my-custom-theme'
            $install_actions[] = '<a href="custom-link">Custom Action</a>';
        }
        return $install_actions;
    }
    // add the filter
    add_filter("install_theme_complete_actions", "weplugins_conditional_install_theme_complete_actions", 10, 4);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("install_theme_complete_actions", "weplugins_modify_install_theme_complete_actions_defaults", 10, 4);
    

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, please contact our Development Team and we’d be happy to assist you.