How to use plupload_default_params filter in WordPress

plupload_default_params filter

Filters the Plupload default parameters.

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

Parameters

Below the 1 parameter is required to use this hook.

• $params: (array) Default Plupload parameters array.

Example 1: Modifying Default Parameters

Below is an example of how you can use this hook to modify default parameters.

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

Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_filter( "plupload_default_params", "weplugins_modify_plupload_default_params_defaults", 10, 1 );
    

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

Example 3: Conditional Modification

An example showing how you can conditionally modify parameters.

    function weplugins_modify_plupload_params_conditional($params) { 
        if (is_admin()) {
            $params['max_file_size'] = '2MB';
        }
        return $params; 
    }
    // add the filter
    add_filter( "plupload_default_params", "weplugins_modify_plupload_params_conditional", 10, 1 );
    

Contact Us

If you’re having any trouble using this hook or need customization, please contact us. We’d be happy to assist you.