Changeset 8318 for trunk/bp-members/bp-members-filters.php

Timestamp:

04/24/2014 09:59:12 PM (11 years ago)

Author:

boonebgorges

Message:

Improved documentation in Members component. See #5022

File:

• trunk/bp-members/bp-members-filters.php (modified) (4 diffs)

trunk/bp-members/bp-members-filters.php

@@ -4 +4 @@
  * BuddyPress Members Filters
  *
- * Member specific filters
+ * Filters specific to the Members component.
  *
  * @package BuddyPress
@@ -14 +14 @@
 
 /**
- * Escape commonly used fullname output functions
+ * Escape commonly used fullname output functions.
  */
 add_filter( 'bp_displayed_user_fullname',    'esc_html' );
@@ -20 +20 @@
 
 /**
- * Load additional sign-up sanitization filters on bp_loaded. These are used
- * to prevent XSS in the BuddyPress sign-up process. You can unhook these to
- * allow for customization of your registration fields, however it is highly
- * recommended that you leave these in place for the safety of your network.
+ * Load additional sign-up sanitization filters on bp_loaded.
  *
- * @since BuddyPress (1.5)
- * @uses add_filter()
+ * These are used to prevent XSS in the BuddyPress sign-up process. You can
+ * unhook these to allow for customization of your registration fields;
+ * however, it is highly recommended that you leave these in place for the
+ * safety of your network.
+ *
+ * @since BuddyPress (1.5.0)
  */
 function bp_members_signup_sanitization() {
@@ -54 +55 @@
 
 /**
- * Filter the user profile URL to point to BuddyPress profile edit
+ * Filter the user profile URL to point to BuddyPress profile edit.
  *
- * @since BuddyPress 1.6
+ * @since BuddyPress (1.6.0)
  *
- * @param string $url
- * @param int $user_id
+ * @param string $url WP profile edit URL.
+ * @param int $user_id ID of the user.
  * @param string $scheme
  * @return string