How to use kses_allowed_protocols filter in WordPress

kses_allowed_protocols filter

Filters the list of protocols allowed in HTML attributes.

To use the kses_allowed_protocols filter, you first 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 modify_kses_allowed_protocols_defaults which takes 1 parameter, and we registered it using add_filter. The first parameter kses_allowed_protocols is the name of the hook, the second parameter modify_kses_allowed_protocols_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 kses_allowed_protocols filter.

Parameters

Below is the 1 parameter required to use this hook.

• $protocols : (string[]) Array of allowed protocols e.g. ‘http’, ‘ftp’, ‘tel’, and more.

Live Example 1: Adding a Custom Protocol

This example shows how to add a custom protocol, ‘skype’, to the list of allowed protocols.

add_filter( 'kses_allowed_protocols', function ( $protocols ) {
        $protocols[] = 'skype';
        return $protocols;
    } );

Live Example 2: Modifying Protocols Conditionally

Below is an example of how you can use this hook to modify the protocols conditionally.

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

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below. Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

remove_filter( "kses_allowed_protocols", "weplugins_modify_kses_allowed_protocols_defaults", 10, 1 );

Contact Us

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