private_title_format │ filter-hook │ WP 2.8.0

Filters the text prepended to the post title of private posts.

The filter is only applied on the front end.

Usage

add_filter( 'private_title_format', 'wp_kama_private_title_format_filter', 10, 2 );

/**
 * Function for `private_title_format` filter-hook.
 * 
 * @param string  $prepend Text displayed before the post title.
 * @param WP_Post $post    Current post object.
 *
 * @return string
 */
function wp_kama_private_title_format_filter( $prepend, $post ){

	// filter...
	return $prepend;
}

$prepend(string)

Text displayed before the post title.
Default: 'Private: %s'

$post(WP_Post)

Current post object.

Changelog

Where the hook is called

$private_title_format = apply_filters( 'private_title_format', $prepend, $post );

Where the hook is used in WordPress