Changeset 2997

Timestamp:

05/13/2010 07:41:35 PM (15 years ago)

Author:

johnjamesjacoby

Message:

Fixes #2278

File:

• branches/1.2/bp-core/bp-core-filters.php (modified) (4 diffs)

branches/1.2/bp-core/bp-core-filters.php

@@ -120 +120 @@
  * Replace the generated password in the welcome email.
  * This will not filter when the site admin registers a user.
+ *
+ * @uses locate_template To see if custom registration files exist
+ * @param string $welcome_email Complete email passed through WordPress
+ * @return string Filtered $welcome_email with 'PASSWORD' replaced by [User Set]
  */
 function bp_core_filter_user_welcome_email( $welcome_email ) {
@@ -126 +130 @@
         return $welcome_email;
 
+    // [User Set] Replaces 'PASSWORD' in welcome email; Represents value set by user
     return str_replace( 'PASSWORD', __( '[User Set]', 'buddypress' ), $welcome_email );
 }
@@ -136 +141 @@
  * Replace the generated password in the welcome email.
  * This will not filter when the site admin registers a user.
+ *
+ * @uses locate_template To see if custom registration files exist
+ * @param string $welcome_email Complete email passed through WordPress
+ * @param integer $blog_id ID of the blog user is joining
+ * @param integer $user_id ID of the user joining
+ * @param string $password Password of user
+ * @return string Filtered $welcome_email with $password replaced by [User Set]
  */
 function bp_core_filter_blog_welcome_email( $welcome_email, $blog_id, $user_id, $password ) {
@@ -142 +154 @@
         return $welcome_email;
 
+    // [User Set] Replaces $password in welcome email; Represents value set by user
     return str_replace( $password, __( '[User Set]', 'buddypress' ), $welcome_email );
 }