Changeset 19974 for trunk/wp-includes/functions.php

Timestamp:

02/21/2012 08:03:11 PM (13 years ago)

Author:

duck_

Message:

Overhaul mysql2date() documentation and parameter names. See #20056.

File:

• trunk/wp-includes/functions.php (modified) (1 diff)

trunk/wp-includes/functions.php

@@ -9 +9 @@
 
 /**
- * Converts MySQL DATETIME field to user specified date format.
- *
- * The $translate parameter will only be used, if it is set to true and it is by
- * default and if the $wp_locale object has the month and weekday set.
+ * Converts given date string into a different format.
+ *
+ * $format should be either a PHP date format string, e.g. 'U' for a Unix
+ * timestamp, or 'G' for a Unix timestamp assuming that $date is GMT.
+ *
+ * If $translate is true then the given date and format string will
+ * be passed to date_i18n() for translation.
  *
  * @since 0.71
  *
- * @param string $dateformatstring Either 'G', 'U', or PHP date format.
- * @param string $mysqlstring Time from mysql DATETIME field.
- * @param bool $translate Optional. Default is true. Will switch format to locale.
- * @return string Date formatted by $dateformatstring or locale (if available).
- */
-function mysql2date( $dateformatstring, $mysqlstring, $translate = true ) {
-    $m = $mysqlstring;
-    if ( empty( $m ) )
+ * @param string $format Format of the date to return.
+ * @param string $date Date string to convert.
+ * @param bool $translate Whether the return date should be translated. Default is true. 
+ * @return string|int Formatted date string, or Unix timestamp.
+ */
+function mysql2date( $format, $date, $translate = true ) {
+    if ( empty( $date ) )
         return false;
 
-    if ( 'G' == $dateformatstring )
-        return strtotime( $m . ' +0000' );
-
-    $i = strtotime( $m );
-
-    if ( 'U' == $dateformatstring )
+    if ( 'G' == $format )
+        return strtotime( $date . ' +0000' );
+
+    $i = strtotime( $date );
+
+    if ( 'U' == $format )
         return $i;
 
     if ( $translate )
-        return date_i18n( $dateformatstring, $i );
+        return date_i18n( $format, $i );
     else
-        return date( $dateformatstring, $i );
+        return date( $format, $i );
 }