Changeset 37738

Timestamp:

06/17/2016 05:11:29 AM (7 years ago)

Author:

peterwilsoncc

Message:

Posts: Add $post parameter to modified date and time functions.

Unifies the APIs for getting a post's modified date or time with getting a post's date or time.

Adds the $post parameter to the functions get_the_modified_date and get_the_modified_time.

Adds the $post parameter to the filters get_the_modified_date and get_the_modified_time.

Props Soean, lukecavanagh.
Fixes #37059.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (5 diffs)
• tests/phpunit/tests/general/template.php (modified) (1 diff)

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

@@ -2255 +2255 @@
  *
  * @since 2.1.0
- *
- * @param string $d Optional. PHP date format. Defaults to the "date_format" option
- * @return string
- */
-function get_the_modified_date($d = '') {
-    if ( '' == $d )
-        $the_time = get_post_modified_time(get_option('date_format'), null, null, true);
-    else
-        $the_time = get_post_modified_time($d, null, null, true);
+ * @since 4.6.0 The `$post` parameter was added.
+ *
+ * @param string      $d    Optional. PHP date format defaults to the date_format option if not specified.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
+ * @return false|string Date the current post was modified. False on failure.
+ */
+function get_the_modified_date( $d = '', $post = null ) {
+    $post = get_post( $post );
+
+    if ( ! $post ) {
+        return false;
+    }
+
+    if ( empty( $d ) ) {
+        $the_time = get_post_modified_time( get_option( 'date_format' ), false, $post, true );
+    } else {
+        $the_time = get_post_modified_time( $d, false, $post, true );
+    }
 
     /**
@@ -2269 +2278 @@
      *
      * @since 2.1.0
-     *
-     * @param string $the_time The formatted date.
-     * @param string $d        PHP date format. Defaults to value specified in
-     *                         'date_format' option.
-     */
-    return apply_filters( 'get_the_modified_date', $the_time, $d );
+     * @since 4.6.0 The `$post` parameter was added.
+     *
+     * @param string  $the_time The formatted date.
+     * @param string  $d        PHP date format. Defaults to value specified in
+     *                          'date_format' option.
+     * @param WP_Post $post     WP_Post object.
+     */
+    return apply_filters( 'get_the_modified_date', $the_time, $d, $post );
 }
 
@@ -2398 +2409 @@
  *
  * @since 2.0.0
- *
- * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
- * @return string
- */
-function get_the_modified_time($d = '') {
-    if ( '' == $d )
-        $the_time = get_post_modified_time(get_option('time_format'), null, null, true);
-    else
-        $the_time = get_post_modified_time($d, null, null, true);
+ * @since 4.6.0 The `$post` parameter was added.
+ *
+ * @param string      $d     Optional. Format to use for retrieving the time the post
+ *                           was modified. Either 'G', 'U', or php date format defaults
+ *                           to the value specified in the time_format option. Default empty.
+ * @param int|WP_Post $post  Optional. Post ID or WP_Post object. Default current post.
+ * @return false|string Formatted date string or Unix timestamp. False on failure.
+ */
+function get_the_modified_time( $d = '', $post = null ) {
+    $post = get_post( $post );
+
+    if ( ! $post ) {
+        return false;
+    }
+
+    if ( empty( $d ) ) {
+        $the_time = get_post_modified_time( get_option( 'time_format' ), false, $post, true );
+    } else {
+        $the_time = get_post_modified_time( $d, false, $post, true );
+    }
 
     /**
@@ -2412 +2434 @@
      *
      * @since 2.0.0
+     * @since 4.6.0 The `$post` parameter was added.
      *
      * @param string $the_time The formatted time.
@@ -2417 +2440 @@
      *                         written. Accepts 'G', 'U', or php date format. Defaults
      *                         to value specified in 'time_format' option.
-     */
-    return apply_filters( 'get_the_modified_time', $the_time, $d );
+     * @param WP_Post $post    WP_Post object.
+     */
+    return apply_filters( 'get_the_modified_time', $the_time, $d, $post );
 }
 

trunk/tests/phpunit/tests/general/template.php

@@ -346 +346 @@
         return $this->custom_logo_id;
     }
+
+    /**
+     * Test get_the_modified_time
+     *
+     * @ticket 37059
+     *
+     * @since 4.6.0
+     */
+    function test_get_the_modified_time_default() {
+        $details = array(
+                'post_date' => '2016-01-21 15:34:36',
+                'post_date_gmt' => '2016-01-21 15:34:36',
+        );
+        $post_id = $this->factory->post->create( $details );
+        $post = get_post( $post_id );
+
+        $GLOBALS['post'] = $post;
+
+        $expected = '1453390476';
+        $d = 'G';
+        $actual = get_the_modified_time( $d );
+        $this->assertEquals( $expected, $actual );
+    }
+
+    /**
+     * Test get_the_modified_time with post_id parameter.
+     *
+     * @ticket 37059
+     *
+     * @since 4.6.0
+     */
+    function test_get_the_modified_time_with_post_id() {
+        $details = array(
+                'post_date' => '2016-01-21 15:34:36',
+                'post_date_gmt' => '2016-01-21 15:34:36',
+        );
+        $post_id = $this->factory->post->create( $details );
+        $d = 'G';
+        $expected = '1453390476';
+        $actual = get_the_modified_time( $d, $post_id );
+        $this->assertEquals( $expected, $actual );
+    }
 }