From 8ec61531158e670059fff05d00464984333c348f Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Tue, 20 Oct 2015 18:13:13 +0000 Subject: [PATCH] Docs: Update the hook doc for the `pre_get_document_title` filter to explain ''what'' value is filterable rather than ''why'' the value is filterable :-) The hook was introduced in [35294]. See #31078. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@35298 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/general-template.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/wp-includes/general-template.php b/src/wp-includes/general-template.php index 0233f4093f..5a22c0a680 100644 --- a/src/wp-includes/general-template.php +++ b/src/wp-includes/general-template.php @@ -793,7 +793,10 @@ function has_site_icon( $blog_id = 0 ) { function wp_get_document_title() { /** - * Allows to short-circuit the title generation. + * Filter the document title before it is generated. + * + * Passing a non-empty value will short-circuit wp_get_document_title(), + * returning that value instead. * * @since 4.4.0 *