How to use js_escape filter in WordPress

js_escape filter

Text passed to esc_js() is stripped of invalid or special characters, and properly slashed for output.

To use the js_escape 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_js_escape_defaults which takes 2 parameters, and we registered it using add_filter. The first parameter js_escape is the name of the hook, the second parameter weplugins_modify_js_escape_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 js_escape filter.

Parameters

Below are the 2 parameters required to use this hook.

• $safe_text : (string) The text after it has been escaped.
• $text : (string) The text prior to being escaped.

Live Example 1

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

    function weplugins_modify_js_escape_defaults($safe_text, $text) { 
        // Update the $safe_text variable according to your website requirements and return this variable. You can modify the $safe_text variable conditionally too if you want.
        return $safe_text; 
    }
    // add the filter
    add_filter("js_escape", "weplugins_modify_js_escape_defaults", 10, 2);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("js_escape", "weplugins_modify_js_escape_defaults", 10, 2);
    

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

Live Example 3

Another example showing conditional modification of the $safe_text variable based on certain conditions.

    function weplugins_custom_js_escape($safe_text, $text) {
        if (strpos($text, 'example') !== false) {
            $safe_text = str_replace('example', 'sample', $safe_text);
        }
        return $safe_text;
    }
    // add the filter
    add_filter("js_escape", "weplugins_custom_js_escape", 10, 2);
    

Contact Us

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