How to use editable_slug filter in WordPress

editable_slug filter

Note: This is a multi-use hook in that it is leveraged both for editable post URIs and term slugs.

To use editable_slug 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_editable_slug_defaults which takes 2 parameters and we registered using add_filter. The first parameter editable_slug is name of the hook, The second parameter modify_editable_slug_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove editable_slug filter.

Parameters

Below are the 2 parameters required to use this hook.

• $slug : (string) The editable slug. Will be either a term slug or post URI depending upon the context in which it is evaluated.
• $tag : (WP_Term|WP_Post) Term or post object.

Live Example

apply_filters( 'editable_slug', string $slug, WP_Term|WP_Post $tag )

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

Example 1: Basic Usage

In this example, we will modify the slug based on certain conditions.

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

Example 2: Conditional Modification

Here, we conditionally modify the slug if the post type is ‘product’.

    function weplugins_modify_editable_slug_for_product($slug, $tag) { 
        if ($tag->post_type == 'product') {
            $slug = 'custom-product-slug';
        }
        return $slug; 
    }
    // add the filter
    add_filter( "editable_slug", "weplugins_modify_editable_slug_for_product", 10, 2 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "editable_slug", "weplugins_modify_editable_slug_defaults", 10, 2 );
    

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