the_title_attribute( string|array $args = '' )

Sanitize 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

$args

(string|array) (Optional) 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 value: ''

Return

(string|void) String when echo is false.

Source

File: wp-includes/post-template.php 

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

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

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

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

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

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/post-template.php: get_the_title()

Retrieve post title.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/formatting.php: esc_attr()

Escaping for HTML attributes.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.

Used By

Used By
Used By Description
wp-includes/general-template.php: feed_links_extra()

Display the links to the extra feeds such as category feeds.
wp-includes/link-template.php: the_shortlink()

Displays the shortlink for a post.
wp-includes/link-template.php: get_adjacent_post_rel_link()

Retrieves the adjacent post relational link.
wp-includes/post-template.php: get_the_content()

Retrieve the post content.

Changelog

Changelog
Version Description
WP-2.3.0 Introduced.