Changeset 10322 for trunk/src/bp-members/bp-members-filters.php

Timestamp:

11/02/2015 01:58:52 AM (9 years ago)

Author:

tw2113

Message:

More documentation cleanup for the Members component.

See #6402.

File:

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

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

@@ -33 +33 @@
 function bp_members_signup_sanitization() {
 
-    // Filters on sign-up fields
+    // Filters on sign-up fields.
     $fields = array (
         'bp_get_signup_username_value',
@@ -44 +44 @@
     );
 
-    // Add the filters to each field
+    // Add the filters to each field.
     foreach( $fields as $filter ) {
         add_filter( $filter, 'esc_html',       1 );
@@ -51 +51 @@
     }
 
-    // Sanitize email
+    // Sanitize email.
     add_filter( 'bp_get_signup_email_value', 'sanitize_email' );
 }
@@ -66 +66 @@
  * @since 2.1.0
  *
- * @param array $illegal_names
- *
+ * @param array $illegal_names Array of illiegal names.
  * @return array $illegal_names
  */
@@ -102 +101 @@
  * @param string $url     WP profile edit URL.
  * @param int    $user_id ID of the user.
- * @param string $scheme
- *
+ * @param string $scheme  Scheme to use.
  * @return string
  */
 function bp_members_edit_profile_url( $url, $user_id, $scheme = 'admin' ) {
 
-    // If xprofile is active, use profile domain link
+    // If xprofile is active, use profile domain link.
     if ( ! is_admin() && bp_is_active( 'xprofile' ) ) {
         $profile_link = trailingslashit( bp_core_get_user_domain( $user_id ) . bp_get_profile_slug() . '/edit' );
 
-    // Default to $url
+    // Default to $url.
     } else {
         $profile_link = $url;