Changeset 36319

Timestamp:

01/15/2016 02:47:00 PM (9 years ago)

Author:

swissspidy

Message:

Posts: Add a $post parameter to get_the_excerpt().

This allows getting the excerpt for a specific post, similar to how most other template tags work.
A deprecation notice is thrown if a boolean value is passed, which is deprecated since 2.3 and has not been used for a long time.
Adds unit tests.

Fixes #27246.

File:

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

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

@@ -358 +358 @@
  *
  * @since 0.71
- *
- * @param mixed $deprecated Not used.
- * @return string
- */
-function get_the_excerpt( $deprecated = '' ) {
-    if ( !empty( $deprecated ) )
+ * @since 4.5.0 Introduced the `$post` parameter.
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @return string Post excerpt.
+ */
+function get_the_excerpt( $post = null ) {
+    if ( is_bool( $post ) ) {
         _deprecated_argument( __FUNCTION__, '2.3' );
-
-    $post = get_post();
+    }
+
+    $post = get_post( $post );
     if ( empty( $post ) ) {
         return '';