Changeset 51019

Timestamp:

05/25/2021 11:42:15 PM (3 years ago)

Author:

desrosj

Message:

Formatting: Introduce the document_title filter.

In wp_get_document_title(), the returned value is currently passed directly through wptexturize(), convert_chars(), and capital_P_dangit(), and is done so after the document_title_parts` filter is run.

This makes it impossible to fully control the output of wp_get_document_title() and is inconsistent with how other similar text is processed with these functions.

This commit introduces the document_title filter, which is run immediately before returning the results of the wp_get_document_title() function and moves the three formatting functions mentioned above to the new filter hook. This allows developers to further modify the title after being prepared by WordPress, or to modify the functions hooked to this filter as they wish.

Props dragunoff, jeremyfelt, paaggeli, audrasjb.
Fixes #51643.

Location:

trunk/src/wp-includes

Files:

• default-filters.php (modified) (2 diffs)
• general-template.php (modified) (1 diff)

trunk/src/wp-includes/default-filters.php

@@ -132 +132 @@
 
 // Format strings for display.
-foreach ( array( 'comment_author', 'term_name', 'link_name', 'link_description', 'link_notes', 'bloginfo', 'wp_title', 'widget_title' ) as $filter ) {
+foreach ( array( 'comment_author', 'term_name', 'link_name', 'link_description', 'link_notes', 'bloginfo', 'wp_title', 'document_title', 'widget_title' ) as $filter ) {
     add_filter( $filter, 'wptexturize' );
     add_filter( $filter, 'convert_chars' );
@@ -139 +139 @@
 
 // Format WordPress.
-foreach ( array( 'the_content', 'the_title', 'wp_title' ) as $filter ) {
+foreach ( array( 'the_content', 'the_title', 'wp_title', 'document_title' ) as $filter ) {
     add_filter( $filter, 'capital_P_dangit', 11 );
 }

trunk/src/wp-includes/general-template.php

@@ -1239 +1239 @@
 
     $title = implode( " $sep ", array_filter( $title ) );
-    $title = wptexturize( $title );
-    $title = convert_chars( $title );
-    $title = esc_html( $title );
-    $title = capital_P_dangit( $title );
+
+    /**
+     * Filters the document title.
+     *
+     * @since 5.8.0
+     *
+     * @param string $title Document title.
+     */
+    $title = apply_filters( 'document_title', $title );
 
     return $title;