Changeset 29344

Timestamp:

08/01/2014 06:39:22 PM (10 years ago)

Author:

wonderboymusic

Message:

Clarify that get_the_date(), get_the_time(), get_post_time() and get_post_modified_time() should return false when get_post() is null.

Adds unit tests.

Props GaryJ, SergeyBiryukov, tollmanz.
Fixes #28310.

Location:

trunk

Files:

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

trunk/src/wp-includes/functions.php

@@ -22 +22 @@
  * @param string $date      Date string to convert.
  * @param bool   $translate Whether the return date should be translated. Default true.
- * @return string|int Formatted date string, or Unix timestamp.
+ * @return string|int|bool Formatted date string or Unix timestamp. False if $date is empty.
  */
 function mysql2date( $format, $date, $translate = true ) {

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

@@ -1726 +1726 @@
  * @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 string Date the current post was written.
+ * @return string|bool Date the current post was written. False on failure.
  */
 function get_the_date( $d = '', $post = null ) {
     $post = get_post( $post );
+
+    if ( ! $post ) {
+        return false;
+    }
 
     if ( '' == $d ) {
@@ -1840 +1844 @@
  *                          to the value specified in the time_format option. Default empty.
  * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
- * @return string|int Formatted date string, or Unix timestamp.
+ * @return string|int|bool Formatted date string or Unix timestamp. False on failure.
  */
 function get_the_time( $d = '', $post = null ) {
     $post = get_post($post);
+
+    if ( ! $post ) {
+        return false;
+    }
 
     if ( '' == $d )
@@ -1874 +1882 @@
  * @param int|WP_Post $post      WP_Post object or ID. Default is global $post object.
  * @param bool        $translate Whether to translate the time string. Default false.
- * @return string|int Formatted date string, or Unix timestamp.
+ * @return string|int|bool Formatted date string or Unix timestamp. False on failure.
  */
 function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
     $post = get_post($post);
+
+    if ( ! $post ) {
+        return false;
+    }
 
     if ( $gmt )
@@ -1952 +1964 @@
  * @since 2.0.0
  *
- * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
- * @param bool $gmt Optional, default is false. Whether to return the gmt time.
- * @param int|object $post Optional, default is global post object. A post_id or post object
- * @param bool $translate Optional, default is false. Whether to translate the result
- * @return string Returns timestamp
+ * @param string      $d         Optional. Format to use for retrieving the time the post
+ *                               was modified. Either 'G', 'U', or php date format. Default 'U'.
+ * @param bool        $gmt       Optional. Whether to retrieve the GMT time. Default false.
+ * @param int|WP_Post $post      WP_Post object or ID. Default is global $post object.
+ * @param bool        $translate Whether to translate the time string. Default false.
+ * @return string|int|bool Formatted date string or Unix timestamp. False on failure.
  */
 function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
     $post = get_post($post);
+
+    if ( ! $post ) {
+        return false;
+    }
 
     if ( $gmt )

trunk/tests/phpunit/tests/post.php

@@ -876 +876 @@
 
     /**
+     * @ticket 28310
+     */
+    function test_get_the_date_returns_false_with_null_post() {
+        $this->assertFalse( get_the_date() );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_date_returns_false_with_format_and_null_post() {
+        $this->assertFalse( get_the_date( 'F j, Y h:i:s' ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_date_returns_false_with_post_that_is_not_found() {
+        $this->assertFalse( get_the_date( '', 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_date_returns_false_with_format_and_post_that_is_not_found() {
+        $this->assertFalse( get_the_date( 'F j, Y h:i:s', 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_time_with_id_returns_correct_time() {
+        $post_id = $this->factory->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+        $this->assertEquals( '16:35:00', get_the_time( 'H:i:s', $post_id ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_time_returns_false_with_null_post() {
+        $this->assertFalse( get_the_time() );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_time_returns_false_with_format_and_null_post() {
+        $this->assertFalse( get_the_time( 'h:i:s' ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_time_returns_false_with_post_that_is_not_found() {
+        $this->assertFalse( get_the_time( '', 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_the_time_returns_false_with_format_and_post_that_is_not_found() {
+        $this->assertFalse( get_the_time( 'h:i:s', 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_time_with_id_returns_correct_time() {
+        $post_id = $this->factory->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+        $this->assertEquals( '16:35:00', get_post_time( 'H:i:s', false, $post_id ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_time_returns_false_with_null_post() {
+        $this->assertFalse( get_post_time() );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_time_returns_false_with_format_and_null_post() {
+        $this->assertFalse( get_post_time( 'h:i:s' ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_time_returns_false_with_post_that_is_not_found() {
+        $this->assertFalse( get_post_time( '', false, 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_time_returns_false_with_format_and_post_that_is_not_found() {
+        $this->assertFalse( get_post_time( 'h:i:s', false, 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_modified_time_with_id_returns_correct_time() {
+        $post_id = $this->factory->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+        $this->assertEquals( '16:35:00', get_post_modified_time( 'H:i:s', false, $post_id ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_modified_time_returns_false_with_null_post() {
+        $this->assertFalse( get_post_modified_time() );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_modified_time_returns_false_with_format_and_null_post() {
+        $this->assertFalse( get_post_modified_time( 'h:i:s' ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_modified_time_returns_false_with_post_that_is_not_found() {
+        $this->assertFalse( get_post_modified_time( '', false, 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_get_post_modified_time_returns_false_with_format_and_post_that_is_not_found() {
+        $this->assertFalse( get_post_modified_time( 'h:i:s', false, 9 ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_mysql2date_returns_false_with_no_date() {
+        $this->assertFalse( mysql2date( 'F j, Y H:i:s', '' ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_mysql2date_returns_gmt_unix_timestamp() {
+        $this->assertEquals( '441013392', mysql2date( 'G', '1983-12-23 07:43:12' ) );
+    }
+
+    /**
+     * @ticket 28310
+     */
+    function test_mysql2date_returns_unix_timestamp() {
+        $this->assertEquals( '441013392', mysql2date( 'U', '1983-12-23 07:43:12' ) );
+    }
+
+    /**
      * @ticket 25566
      */