Changeset 5420

Timestamp:

06/27/2014 03:23:15 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Update a few documentation blocks in common/functions.php that had missing or incorrect references.

File:

• trunk/src/includes/common/functions.php (modified) (5 diffs)

trunk/src/includes/common/functions.php

@@ -61 +61 @@
  * @since bbPress (r2455)
  *
- * @param int|object $post Optional. Default is global post object. A post_id or
- *                          post object
+ * @param string $time Time to convert
  * @param string $d Optional. Default is 'U'. Either 'G', 'U', or php date
  *                             format
@@ -73 +72 @@
  */
 function bbp_convert_date( $time, $d = 'U', $translate = false ) {
-    $time = mysql2date( $d, $time, $translate );
-
-    return apply_filters( 'bbp_convert_date', $time, $d, $translate );
+    $new_time = mysql2date( $d, $time, $translate );
+
+    return apply_filters( 'bbp_convert_date', $new_time, $d, $translate, $time );
 }
 
@@ -206 +205 @@
  * @since bbPress (r2782)
  *
- * @param int $topic_id Optional. Topic id
+ * @param string $reason Optional. User submitted reason for editing.
  * @return string Status of topic
  */
@@ -213 +212 @@
 
     // Format reason for proper display
-    if ( empty( $reason ) )
+    if ( empty( $reason ) ) {
         return $reason;
+    }
 
     // Trimming
@@ -220 +220 @@
 
     // We add our own full stop.
-    while ( substr( $reason, -1 ) === '.' )
+    while ( substr( $reason, -1 ) === '.' ) {
         $reason = substr( $reason, 0, -1 );
+    }
 
     // Trim again