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
This commit is contained in:
Drew Jaynes 2015-10-20 18:13:13 +00:00
parent e5ec034d8f
commit 8ec6153115
1 changed files with 4 additions and 1 deletions

View File

@ -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
*