Changeset 9696

Timestamp:

04/05/2015 04:30:16 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation for class-bp-core-user.php.

See #5940.

File:

• trunk/src/bp-core/classes/class-bp-core-user.php (modified) (6 diffs)

trunk/src/bp-core/classes/class-bp-core-user.php

@@ -377 +377 @@
                 }
 
-                // Get paginated results
+                /**
+                 * Filters the SQL used to query for paged users.
+                 *
+                 * @since BuddyPress (1.2.6)
+                 *
+                 * @param string $value Concatenated SQL statement for the query.
+                 * @param array  $sql   Array of SQL statement parts for the query.
+                 */
                 $paged_users_sql = apply_filters( 'bp_core_get_paged_users_sql', join( ' ', (array) $sql ), $sql );
                 $paged_users     = $wpdb->get_results( $paged_users_sql );
@@ -402 +409 @@
                 array_unshift( $sql, "SELECT COUNT(u.ID)" );
 
-                // Get total user results
+                /**
+                 * Filters the SQL used to query for total users.
+                 *
+                 * @since BuddyPress (1.2.6)
+                 *
+                 * @param string $value Concatenated SQL statement for the query.
+                 * @param array  $sql   Array of SQL statement parts for the query.
+                 */
                 $total_users_sql = apply_filters( 'bp_core_get_total_users_sql', join( ' ', (array) $sql ), $sql );
                 $total_users     = $wpdb->get_var( $total_users_sql );
@@ -471 +485 @@
                 }
 
+                /**
+                 * Filters the SQL used to query for total user count by first letter.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param string $value SQL prepared statement for the user count query.
+                 */
                 $total_users_sql = apply_filters( 'bp_core_users_by_letter_count_sql', $wpdb->prepare( "SELECT COUNT(DISTINCT u.ID) FROM {$wpdb->users} u LEFT JOIN {$bp->profile->table_name_data} pd ON u.ID = pd.user_id LEFT JOIN {$bp->profile->table_name_fields} pf ON pd.field_id = pf.id WHERE {$status_sql} AND pf.name = %s {$exclude_sql} AND pd.value LIKE %s ORDER BY pd.value ASC", bp_xprofile_fullname_field_name(), $letter_like ) );
+
+                /**
+                 * Filters the SQL used to query for users by first letter.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param string $value SQL prepared statement for the user query.
+                 */
                 $paged_users_sql = apply_filters( 'bp_core_users_by_letter_sql',       $wpdb->prepare( "SELECT DISTINCT u.ID as id, u.user_registered, u.user_nicename, u.user_login, u.user_email FROM {$wpdb->users} u LEFT JOIN {$bp->profile->table_name_data} pd ON u.ID = pd.user_id LEFT JOIN {$bp->profile->table_name_fields} pf ON pd.field_id = pf.id WHERE {$status_sql} AND pf.name = %s {$exclude_sql} AND pd.value LIKE %s ORDER BY pd.value ASC{$pag_sql}", bp_xprofile_fullname_field_name(), $letter_like ) );
 
@@ -564 +593 @@
                 $status_sql        = bp_core_get_status_sql( 'u.' );
 
+                /**
+                 * Filters the SQL used to query for searched users count.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param string $value SQL statement for the searched users count query.
+                 */
                 $total_users_sql = apply_filters( 'bp_core_search_users_count_sql', $wpdb->prepare( "SELECT COUNT(DISTINCT u.ID) as id FROM {$wpdb->users} u LEFT JOIN {$bp->profile->table_name_data} pd ON u.ID = pd.user_id WHERE {$status_sql} AND pd.value LIKE %s ORDER BY pd.value ASC", $search_terms_like ), $search_terms );
+
+                /**
+                 * Filters the SQL used to query for searched users.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param string $value SQL statement for the searched users query.
+                 */
                 $paged_users_sql = apply_filters( 'bp_core_search_users_sql',       $wpdb->prepare( "SELECT DISTINCT u.ID as id, u.user_registered, u.user_nicename, u.user_login, u.user_email FROM {$wpdb->users} u LEFT JOIN {$bp->profile->table_name_data} pd ON u.ID = pd.user_id WHERE {$status_sql} AND pd.value LIKE %s ORDER BY pd.value ASC{$pag_sql}", $search_terms_like ), $search_terms, $pag_sql );
 
@@ -739 +783 @@
          * existing entry.
          *
-         * @since 2.0
+         * @since BuddyPress (2.0.0)
          *
          * @param int $user_id ID of the user whose last_activity you are updating.
@@ -828 +872 @@
          * Delete a user's last_activity value.
          *
-         * @since 2.0
+         * @since BuddyPress (2.0.0)
          *
          * @param int $user_id