How to use plugin_files_exclusions filter in WordPress

plugin_files_exclusions filter

Filters the array of excluded directories and files while scanning the folder.

To use plugin_files_exclusions 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_files_exclusions_defaults which takes 1 parameter and we registered using add_filter. The first parameter plugin_files_exclusions is the name of the hook, the second parameter weplugins_modify_plugin_files_exclusions_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_files_exclusions filter.

Parameters

Below the 1 parameter is required to use this hook.

• $exclusions : (string[]) Array of excluded directories and files.

Live Example

apply_filters( 'plugin_files_exclusions', string[] $exclusions )

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

Example 1: Basic Usage

This example shows how to modify the exclusions array.

    function weplugins_modify_plugin_files_exclusions_defaults($exclusions) { 
        // Update the $exclusions variable according to your website requirements and return this variable. You can modify the $exclusions variable conditionally too if you want.
        return $exclusions; 
    }
    // add the filter
    add_filter( "plugin_files_exclusions", "weplugins_modify_plugin_files_exclusions_defaults", 10, 1 );
    

Example 2: Conditional Exclusion

This example demonstrates modifying the exclusions array conditionally based on certain criteria.

    function weplugins_conditional_plugin_files_exclusions($exclusions) { 
        if (is_admin()) {
            $exclusions[] = 'some-directory/';
        }
        return $exclusions; 
    }
    // add the filter
    add_filter( "plugin_files_exclusions", "weplugins_conditional_plugin_files_exclusions", 10, 1 );
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "plugin_files_exclusions", "weplugins_modify_plugin_files_exclusions_defaults", 10, 1 );
    

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

Contact Us

If you need customization or are having trouble using this hook, feel free to contact us.