How to use available_permalink_structure_tags filter in WordPress

available_permalink_structure_tags filter

Filters the list of available permalink structure tags on the Permalinks settings page.

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

Parameters

Below the 1 parameter is required to use this hook.

• $available_tags: (string[]) An array of key => value pairs of available permalink structure tags.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("available_permalink_structure_tags", "weplugins_modify_available_permalink_structure_tags_defaults", 10, 1);
    

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 to modify the available permalink structure tags:

    function weplugins_another_custom_permalink_tags($available_tags) {
        $available_tags['%custom_tag%'] = 'Custom Tag';
        return $available_tags;
    }
    // add the filter
    add_filter("available_permalink_structure_tags", "weplugins_another_custom_permalink_tags", 10, 1);
    

Contact Us

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