How to use protected_title_format filter in WordPress

protected_title_format filter

The filter is only applied on the front end.

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

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 weplugins_modify_protected_title_format_defaults which takes 2 parameters and we register it using add_filter. The first parameter protected_title_format is the name of the hook, the second parameter weplugins_modify_protected_title_format_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 protected_title_format filter.

Parameters

Below are the 2 parameters required to use this hook.

• $prepend: (string) Text displayed before the post title. Default ‘Protected: %s’.
• $post: (WP_Post) Current post object.

Live Example

Example 1: Removing ‘Protected’ from Titles

In this example, we remove the ‘Protected’ text from the post titles.

    add_filter( 'protected_title_format', 'weplugins_remove_protected_from_titles' );
    function weplugins_remove_protected_from_titles( $format, $post ) {
        return '%s';
    }
    

Example 2: Modifying the Prepend Text

Below is an example of how you can modify the prepend text conditionally based on your requirements.

    function weplugins_modify_protected_title_format_defaults($prepend, $post) {
        // Update the $prepend variable according to your website requirements and return this variable.
        return $prepend;
    }
    // add the filter
    add_filter( "protected_title_format", "weplugins_modify_protected_title_format_defaults", 10, 2 );
    

Example 3: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "protected_title_format", "weplugins_modify_protected_title_format_defaults", 10, 2 );
    

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

Contact Us

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