How to use print_scripts_array filter in WordPress

print_scripts_array filter

Filters the list of script dependencies left to print.

To use the print_scripts_array filter, first you have to register it using add_filter. You can write this code into the 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_print_scripts_array_defaults which takes 1 parameter and we registered it using add_filter. The first parameter print_scripts_array is the name of the hook, the second parameter weplugins_modify_print_scripts_array_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 print_scripts_array filter.

Parameters

Below, the 1 parameter is required to use this hook.

• $to_do : (string[]) An array of script dependency handles.

Live Example

apply_filters( 'print_scripts_array', string[] $to_do )

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

Example 1: Modifying the Script Dependencies

This example demonstrates how to modify the script dependencies using the print_scripts_array filter.

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

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

remove_filter( "print_scripts_array", "weplugins_modify_print_scripts_array_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 of Script Dependencies

This example shows how to conditionally modify the script dependencies based on certain criteria.

function weplugins_conditional_modify_print_scripts_array($to_do) { 
    if ( is_admin() ) {
        // Modify $to_do only for admin pages
        $to_do[] = 'custom-admin-script';
    }
    return $to_do; 
}
// add the filter
add_filter( "print_scripts_array", "weplugins_conditional_modify_print_scripts_array", 10, 1 );

Contact Us

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