the_title_attribute() – Function | Developer.WordPress.org

Sanitizes the current title when retrieving or displaying.

Description

Works like the_title() , except the parameters can be in a string or an array. See the function for what can be override in the $args parameter.

The title before it is displayed will have the tags stripped and esc_attr() before it is passed to the user or displayed. The default as with the_title() , is to display the title.

Parameters

$argsstring|arrayoptional

Title attribute arguments. Optional.

before string
Markup to prepend to the title.
after string
Markup to append to the title.
echo bool
Whether to echo or return the title. Default true for echo.
post WP_Post
Current post object to retrieve the title for.

Default:''

Return

void|string Void if 'echo' argument is true, the title attribute if 'echo' is false.

Source

function the_title_attribute( $args = '' ) {
	$defaults    = array(
		'before' => '',
		'after'  => '',
		'echo'   => true,
		'post'   => get_post(),
	);
	$parsed_args = wp_parse_args( $args, $defaults );

	$title = get_the_title( $parsed_args['post'] );

	if ( strlen( $title ) === 0 ) {
		return;
	}

	$title = $parsed_args['before'] . $title . $parsed_args['after'];
	$title = esc_attr( strip_tags( $title ) );

	if ( $parsed_args['echo'] ) {
		echo $title;
	} else {
		return $title;
	}
}

View all references View on Trac View on GitHub

Uses	Description
get_the_title()`wp-includes/post-template.php`	Retrieves the post title.
esc_attr()`wp-includes/formatting.php`	Escaping for HTML attributes.
wp_parse_args()`wp-includes/functions.php`	Merges user defined arguments into defaults array.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Show 2 more Show less

Used by	Description
feed_links_extra()`wp-includes/general-template.php`	Displays the links to the extra feeds such as category feeds.
the_shortlink()`wp-includes/link-template.php`	Displays the shortlink for a post.
get_adjacent_post_rel_link()`wp-includes/link-template.php`	Retrieves the adjacent post relational link.
get_the_content()`wp-includes/post-template.php`	Retrieves the post content.

Changelog

Version	Description
2.3.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
PHP with text args
```
printf(	'<a href="%s" title="%s">%s</a>',
	get_permalink(),
	the_title_attribute( 'echo=0' ),
	get_the_title()
);
```
Log in to add feedback
Skip to note 5 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Inline with array args
```
<a href="<?php the_permalink(); ?>" 
	title="<?php the_title_attribute( array(
		'before' => 'Permalink to: ',
		'after'  => ''
	) ); ?>">
	<?php the_title(); ?>
</a>
```
Log in to add feedback
Skip to note 6 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Inline with text args
```
/**
 * Output the post title.
 */
function wpdocs_do_post_title() {
	?>
	<a href="<?php the_permalink(); ?>" title="<?php the_title_attribute( 'before=Permalink to: "&after="' ); ?>"><?php the_title(); ?></a>
	<?php
}
```
Log in to add feedback

the_title_attribute( string|array $args = ” ): void|string

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes

the_title_attribute( string|array $args = ” ): void|string

In this article

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes