Changeset 9026 for trunk/src/bp-groups/bp-groups-filters.php

Timestamp:

09/17/2014 12:39:27 AM (11 years ago)

Author:

boonebgorges

Message:

Improved inline documentation in bp-groups

See #5022

File:

• trunk/src/bp-groups/bp-groups-filters.php (modified) (6 diffs)

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

@@ -111 +111 @@
 }
 
-/** Group forums **************************************************************/
-
-/**
- * Only filter the forum SQL on group pages or on the forums directory
+/** Legacy group forums (bbPress 1.x) *****************************************/
+
+/**
+ * Filter bbPress query SQL when on group pages or on forums directory.
  */
 function groups_add_forum_privacy_sql() {
@@ -123 +123 @@
 add_filter( 'bbpress_init', 'groups_add_forum_privacy_sql' );
 
+/**
+ * Add fields to bbPress query for group-specific data.
+ *
+ * @param string $sql
+ * @return string
+ */
 function groups_add_forum_fields_sql( $sql = '' ) {
     $sql = 't.*, g.id as object_id, g.name as object_name, g.slug as object_slug';
@@ -128 +134 @@
 }
 
+/**
+ * Add JOINed tables to bbPress query for group-specific data.
+ *
+ * @param string $sql
+ * @return string
+ */
 function groups_add_forum_tables_sql( $sql = '' ) {
     global $bp;
@@ -136 +148 @@
 }
 
+/**
+ * Add WHERE clauses to bbPress query for group-specific data and access protection.
+ *
+ * @param string $sql
+ * @return string
+ */
 function groups_add_forum_where_sql( $sql = '' ) {
     global $bp;
@@ -179 +197 @@
 }
 
+/**
+ * Modify bbPress caps for bp-forums.
+ *
+ * @param bool $value
+ * @param string $cap
+ * @param array $args
+ * @return bool
+ */
 function groups_filter_bbpress_caps( $value, $cap, $args ) {
     global $bp;
@@ -196 +222 @@
 
 /**
- * Amends the forum directory's "last active" bbPress SQL query to stop it fetching
- * information we aren't going to use. This speeds up the query.
+ * Amends the forum directory's "last active" bbPress SQL query to stop it fetching information we aren't going to use.
+ *
+ * This speeds up the query.
+ *
+ * @since BuddyPress (1.5.0)
  *
  * @see BB_Query::_filter_sql()
- * @since BuddyPress (1.5)
  */
 function groups_filter_forums_root_page_sql( $sql ) {