How to use private_title_format filter in WordPress

private_title_format filter

The filter is only applied on the front end.

To use private_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.

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_private_title_format_defaults which takes 2 parameters and we registered using add_filter. The first parameter private_title_format is the name of the hook, the second parameter modify_private_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.

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

Parameters

Below are the 2 parameters required to use this hook.

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

Live Examples

Example 1: Remove ‘Private’ Prefix from Post Titles

In this example, we will remove the ‘Private’ prefix from post titles.

    add_filter( 'private_title_format', 'weplugins_remove_private_protected_from_titles' );
    function weplugins_remove_private_protected_from_titles( $format, $post ) {
        return '%s';
    }
    

Example 2: Modify Private Title Format

Below is an example of how you can use this hook to modify the private title format.

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

Example 3: Remove Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "private_title_format", "weplugins_modify_private_title_format_defaults", 10, 2 );
    

Please make sure you 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 or need customization, please Contact Us and we’d be happy to assist you.