Retrieves the post title.
Description
If the post is protected and the visitor is not an admin, then "Protected" will be inserted before the post title. If the post is private, then "Private" will be inserted before the post title.
Parameters
Source
function get_the_title( $post = 0 ) {
$post = get_post( $post );
$post_title = isset( $post->post_title ) ? $post->post_title : '';
$post_id = isset( $post->ID ) ? $post->ID : 0;
if ( ! is_admin() ) {
if ( ! empty( $post->post_password ) ) {
/* translators: %s: Protected post title. */
$prepend = __( 'Protected: %s' );
/**
* Filters the text prepended to the post title for protected posts.
*
* The filter is only applied on the front end.
*
* @since 2.8.0
*
* @param string $prepend Text displayed before the post title.
* Default 'Protected: %s'.
* @param WP_Post $post Current post object.
*/
$protected_title_format = apply_filters( 'protected_title_format', $prepend, $post );
$post_title = sprintf( $protected_title_format, $post_title );
} elseif ( isset( $post->post_status ) && 'private' === $post->post_status ) {
/* translators: %s: Private post title. */
$prepend = __( 'Private: %s' );
/**
* Filters the text prepended to the post title of private posts.
*
* The filter is only applied on the front end.
*
* @since 2.8.0
*
* @param string $prepend Text displayed before the post title.
* Default 'Private: %s'.
* @param WP_Post $post Current post object.
*/
$private_title_format = apply_filters( 'private_title_format', $prepend, $post );
$post_title = sprintf( $private_title_format, $post_title );
}
}
/**
* Filters the post title.
*
* @since 0.71
*
* @param string $post_title The post title.
* @param int $post_id The post ID.
*/
return apply_filters( 'the_title', $post_title, $post_id );
}
Hooks
- apply_filters( ‘private_title_format’,
string $prepend ,WP_Post $post ) Filters the text prepended to the post title of private posts.
- apply_filters( ‘protected_title_format’,
string $prepend ,WP_Post $post ) Filters the text prepended to the post title for protected posts.
- apply_filters( ‘the_title’,
string $post_title ,int $post_id ) Filters the post title.
Changelog
| Version | Description |
|---|---|
| 0.71 | Introduced. |
get_the_title intentionally allows for HTML
So get_the_title should not be escaped.
Use
the_title_attribute()instead ofget_the_title()if you’re outputting the post title for html attributes.get_the_titleshould be escaped.Super admins and administrators have the ability to enter arbitrary HTML in the title field, but that doesn’t prevent problems from appearing, for example:
scripttag with malicious javscriptAll of this is a non-issue with escaping, which makes sure what’s outputted is what you expected. That doesn’t mean you can’t let users put HTML in there, as long as you specify which tags are allowed
To display the title safely, do this:
And if you want the title to include HTML tags:
get_the_title(), don’t be surprised when you get escaped tags in your output. If you want just the title with without any markup, you need to usethe_title_attribute()instead, as described by @kenshino above. Plugins can and do add markup to the the title via the hookthe_title.Print the current post’s title
Simple breadcrumb trail for pages, two levels deep.
get_the_titleis being filtered before value return. If you are checking for raw value of a post title, for empty titles you might get an ‘untitled’ string value depending on the locale of the blog. In order to get raw value of a post title, useget_postand access itspost_titleproperty