Docs: Fix indentation and improve usefulness of inline comments surrounding the if/elseif conditions for assigning document titles in `wp_get_document_title()`.

See #31078. See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35300 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-10-20 18:30:59 +00:00
parent e9579b3ed5
commit b11b651d24
1 changed files with 12 additions and 11 deletions

View File

@ -813,38 +813,39 @@ function wp_get_document_title() {
'title' => '', 'title' => '',
); );
// If on the home or front page, use the site title.
if ( is_home() && is_front_page() ) { if ( is_home() && is_front_page() ) {
$title['title'] = get_bloginfo( 'name', 'display' ); $title['title'] = get_bloginfo( 'name', 'display' );
/* /*
* If we're on the blog page and that page is not the homepage or a single page that is designated as * If we're on the blog page and that page is not the homepage or a single
* the homepage, use the container page's title. * page that is designated as the homepage, use the container page's title.
*/ */
} elseif ( ( is_home() && ! is_front_page() ) || ( ! is_home() && is_front_page() ) ) { } elseif ( ( is_home() && ! is_front_page() ) || ( ! is_home() && is_front_page() ) ) {
$title['title'] = single_post_title( '', false ); $title['title'] = single_post_title( '', false );
// If we're on a post / page. // If on a single post of any post type, use the post title.
} elseif ( is_singular() ) { } elseif ( is_singular() ) {
$title['title'] = single_post_title( '', false ); $title['title'] = single_post_title( '', false );
// If we're on a category or tag or taxonomy archive. // If on a category or tag or taxonomy archive, use the archive title.
} elseif ( is_category() || is_tag() || is_tax() ) { } elseif ( is_category() || is_tag() || is_tax() ) {
$title['title'] = single_term_title( '', false ); $title['title'] = single_term_title( '', false );
// If it's a search. // If it's a search, use a dynamic search results title.
} elseif ( is_search() ) { } elseif ( is_search() ) {
/* translators: %s: search phrase */ /* translators: %s: search phrase */
$title['title'] = sprintf( __( 'Search Results for “%s”' ), get_search_query() ); $title['title'] = sprintf( __( 'Search Results for “%s”' ), get_search_query() );
// If we're on an author archive. // If on an author archive, use the author's display name.
} elseif ( is_author() && $author = get_queried_object() ) { } elseif ( is_author() && $author = get_queried_object() ) {
$title['title'] = $author->display_name; $title['title'] = $author->display_name;
// If we're on a post type archive. // If on a post type archive, use the post type archive title.
} elseif ( is_post_type_archive() ) { } elseif ( is_post_type_archive() ) {
$title['title'] = post_type_archive_title( '', false ); $title['title'] = post_type_archive_title( '', false );
// If it's a date archive. // If it's a date archive, use the date as the title.
} elseif ( is_year() ) { } elseif ( is_year() ) {
$title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) ); $title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) );
@ -854,7 +855,7 @@ function wp_get_document_title() {
} elseif ( is_day() ) { } elseif ( is_day() ) {
$title['title'] = get_the_date(); $title['title'] = get_the_date();
// If it's a 404 page. // If it's a 404 page, use a "Page not found" title.
} elseif ( is_404() ) { } elseif ( is_404() ) {
$title['title'] = __( 'Page not found' ); $title['title'] = __( 'Page not found' );
} }