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

Timestamp:

11/22/2015 04:58:34 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for BP-Groups component.

See #6401.

File:

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

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

@@ -10 +10 @@
 defined( 'ABSPATH' ) || exit;
 
-// Filter bbPress template locations
-
+// Filter bbPress template locations.
 add_filter( 'bp_groups_get_directory_template', 'bp_add_template_locations' );
 add_filter( 'bp_get_single_group_template',    'bp_add_template_locations' );
@@ -51 +50 @@
 add_filter( 'groups_group_description_before_save', 'force_balance_tags' );
 
-// Trim trailing spaces from name and description when saving
+// Trim trailing spaces from name and description when saving.
 add_filter( 'groups_group_name_before_save',        'trim' );
 add_filter( 'groups_group_description_before_save', 'trim' );
 
-// Escape output of new group creation details
+// Escape output of new group creation details.
 add_filter( 'bp_get_new_group_id',          'esc_attr'     );
 add_filter( 'bp_get_new_group_name',        'esc_attr'     );
 add_filter( 'bp_get_new_group_description', 'esc_textarea' );
 
-// Format numberical output
+// Format numberical output.
 add_filter( 'bp_get_total_group_count',          'bp_core_number_format' );
 add_filter( 'bp_get_group_total_for_member',     'bp_core_number_format' );
@@ -71 +70 @@
  * @since 1.1.0
  *
- * @param string $content
- *
+ * @param string $content Content to filter.
  * @return string
  */
@@ -87 +85 @@
     $allowed_tags = wp_kses_allowed_html( 'buddypress-groups' );
 
-    // Add our own tags allowed in group descriptions
+    // Add our own tags allowed in group descriptions.
     $allowed_tags['a']['class']    = array();
     $allowed_tags['img']           = array();
@@ -107 +105 @@
     $tags = apply_filters( 'bp_groups_filter_kses', $allowed_tags );
 
-    // Return KSES'ed content, allowing the above tags
+    // Return KSES'ed content, allowing the above tags.
     return wp_kses( $content, $tags );
 }
@@ -126 +124 @@
  * Add fields to bbPress query for group-specific data.
  *
- * @param string $sql
- *
+ * @param string $sql SQL statement to amend.
  * @return string
  */
@@ -138 +135 @@
  * Add JOINed tables to bbPress query for group-specific data.
  *
- * @param string $sql
- *
+ * @param string $sql SQL statement to amend.
  * @return string
  */
@@ -153 +149 @@
  * Add WHERE clauses to bbPress query for group-specific data and access protection.
  *
- * @param string $sql
+ * @param string $sql SQL Statement to amend.
  *
  * @return string
@@ -159 +155 @@
 function groups_add_forum_where_sql( $sql = '' ) {
 
-    // Define locale variable
+    // Define locale variable.
     $parts = array();
 
-    // Set this for groups
+    // Set this for groups.
     $parts['groups'] = "(gm.meta_key = 'forum_id' AND gm.meta_value = t.forum_id)";
 
@@ -173 +169 @@
      * Decide if private are visible
      */
+
     // Are we in our own profile?
     if ( bp_is_my_profile() )
@@ -181 +178 @@
         unset( $parts['private'] );
 
-    // No need to filter on a single item
+    // No need to filter on a single item.
     elseif ( bp_is_single_item() )
         unset( $parts['private'] );
 
-    // Check the SQL filter that was passed
+    // Check the SQL filter that was passed.
     if ( !empty( $sql ) )
         $parts['passed'] = $sql;
 
-    // Assemble Voltron
+    // Assemble Voltron.
     $parts_string = implode( ' AND ', $parts );
 
     $bp = buddypress();
 
-    // Set it to the global filter
+    // Set it to the global filter.
     $bp->groups->filter_sql = $parts_string;
 
-    // Return the global filter
+    // Return the global filter.
     return $bp->groups->filter_sql;
 }
@@ -204 +201 @@
  * Modify bbPress caps for bp-forums.
  *
- * @param bool $value
- * @param string $cap
- * @param array $args
+ * @param bool   $value Original value for current_user_can check.
+ * @param string $cap   Capability checked.
+ * @param array  $args  Arguments for the caps.
  *
  * @return bool
@@ -238 +235 @@
  *
  * @see BB_Query::_filter_sql()
+ *
+ * @param string $sql SQL statement.
+ * @return string
  */
 function groups_filter_forums_root_page_sql( $sql ) {
@@ -262 +262 @@
  * @param bool $load_mentions    True to load mentions assets, false otherwise.
  * @param bool $mentions_enabled True if mentions are enabled.
- *
  * @return bool True if mentions scripts should be loaded.
  */