Changeset 27148 for trunk/src/wp-includes/general-template.php

Timestamp:

02/09/2014 09:02:36 PM (11 years ago)

Author:

DrewAPicture

Message:

Improve inline documenation for get_the_time() and `get_post_time().

Props ruud@joyo for the initial patch.
Fixes #26682.

File:

• trunk/src/wp-includes/general-template.php (modified) (2 diffs)

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

@@ -1500 +1500 @@
  * @since 1.5.0
  *
- * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
- * @param int|object $post Optional post ID or object. Default is global $post object.
- * @return string
+ * @param string      $d    Optional. Format to use for retrieving the time the post
+ *                          was written. Either 'G', 'U', or php date format defaults
+ *                          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.
  */
 function get_the_time( $d = '', $post = null ) {
@@ -1519 +1521 @@
  * @since 2.0.0
  *
- * @param string $d Optional 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 post ID or object. Default is global $post object.
- * @param bool $translate Whether to translate the time string
- * @return string
- */
-function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) { // returns timestamp
+ * @param string      $d         Optional. Format to use for retrieving the time the post
+ *                               was written. 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 Formatted date string, or Unix timestamp.
+ */
+function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
     $post = get_post($post);