Changeset 10183 for trunk/src/bp-forums/bp-forums-filters.php

Timestamp:

10/04/2015 07:29:24 AM (9 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the BP Forums Component.

See #6397.

File:

• trunk/src/bp-forums/bp-forums-filters.php (modified) (3 diffs)

trunk/src/bp-forums/bp-forums-filters.php

@@ -98 +98 @@
  * Get a link for a forum topic tags directory.
  *
- * @param string $link Link passed from filter.
- * @param string $tag Name of the tag.
- * @param string $page Page number, passed from the filter.
+ * @param string $link    Link passed from filter.
+ * @param string $tag     Name of the tag.
+ * @param string $page    Page number, passed from the filter.
  * @param string $context Passed from the filter but unused here.
  * @return string Link of the form http://example.com/forums/tag/tagname/.
@@ -142 +142 @@
  * @see bp_modify_page_title()
  *
- * @param string $title New page title; see {@link bp_modify_page_title()}.
+ * @param string $title          New page title; see {@link bp_modify_page_title()}.
  * @param string $original_title Original page title.
- * @param string $sep How to separate the various items within the page title.
- * @param string $seplocation Direction to display title.
+ * @param string $sep            How to separate the various items within the page title.
+ * @param string $seplocation    Direction to display title.
  * @return string Page title with forum topic title appended.
  */
@@ -232 +232 @@
     $sql .= $wpdb->prepare( " AND p.poster_id = %s ", bp_displayed_user_id() );
 
-    // Remove any topic_author information
+    // Remove any topic_author information.
     $sql = str_replace( " AND t.topic_poster = '" . bp_displayed_user_id() . "'", '', $sql );