How to use quicktags_settings filter in WordPress

quicktags_settings filter

Filters the Quicktags settings.

To use the `quicktags_settings` 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.

At WePlugins, 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_quicktags_settings_defaults` which takes 2 parameters and we registered using `add_filter`. The first parameter `quicktags_settings` is the name of the hook, the second parameter `modify_quicktags_settings_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 `quicktags_settings` filter.

Parameters

Below are the 2 parameters required to use this hook.

• $qtInit : (array) Quicktags settings.
• $editor_id : (string) Unique editor identifier, e.g. ‘content’.

Live Example

apply_filters( 'quicktags_settings', array $qtInit, string $editor_id )

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

Example 1: Modify Quicktags Settings

This example demonstrates how to modify the Quicktags settings for different editors.

function weplugins_modify_quicktags_settings_defaults($qtInit, $editor_id) { 
    // Update the $qtInit variable according to your website requirements and return this variable. You can modify the $qtInit variable conditionally too if you want.
    return $qtInit; 
}
// Add the filter
add_filter( "quicktags_settings", "weplugins_modify_quicktags_settings_defaults", 10, 2 );

Example 2: Remove Quicktags Settings Filter

To remove a hook callback, use the example below.

remove_filter( "quicktags_settings", "weplugins_modify_quicktags_settings_defaults", 10, 2 );

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

Example 3: Conditional Quicktags Settings

This example shows how to modify Quicktags settings conditionally based on the editor ID.

function weplugins_conditional_quicktags_settings($qtInit, $editor_id) { 
    if($editor_id === 'content') {
        // Modify $qtInit for 'content' editor
    } else {
        // Modify $qtInit for other editors
    }
    return $qtInit; 
}
// Add the filter with conditional logic
add_filter( "quicktags_settings", "weplugins_conditional_quicktags_settings", 10, 2 );

If you need further customization, feel free to Contact Us.