Changeset 35298

Timestamp:

10/20/2015 06:13:13 PM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/general-template.php (modified) (1 diff)

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

@@ -794 +794 @@
 
     /**
-     * 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