Changeset 13165

Timestamp:

12/10/2021 04:13:57 PM (2 years ago)

Author:

dcavins

Message:

BP_Signup improvements.

On multisite, when resending actvation emails, send the
right kind (user or user + site). Also ensure that default
meta is set via wpmu meta filters.

introduce bp_members_get_signup_by() and
bp_members_site_requests_enabled().

Correct default value calculation in BP_Signup
to allow backcompat.

See #8540.

Location:

trunk/src

Files:

• bp-core/bp-core-filters.php (modified) (2 diffs)
• bp-members/bp-members-functions.php (modified) (2 diffs)
• bp-members/classes/class-bp-members-admin.php (modified) (1 diff)
• bp-members/classes/class-bp-signup.php (modified) (2 diffs)

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

@@ -474 +474 @@
     );
 
-    $signups = BP_Signup::get(
-        array(
-            'user_login' => $user,
-        )
-    );
-
+    $signup     = bp_members_get_signup_by( 'activation_key', $key );
     $salutation = $user;
-    if ( $signups && bp_is_active( 'xprofile' ) ) {
-        $signup = $signups['signups'][0];
+    if ( $signup && bp_is_active( 'xprofile' ) ) {
         if ( isset( $signup->meta[ 'field_' . bp_xprofile_fullname_field_id() ] ) ) {
             $salutation = $signup->meta[ 'field_' . bp_xprofile_fullname_field_id() ];
@@ -563 +557 @@
 }
 add_filter( 'wpmu_signup_user_notification', 'bp_core_activation_signup_user_notification', 1, 4 );
+
+/**
+ * Ensure that some meta values are set for new multisite signups.
+ *
+ * @since 10.0.0
+ *
+ * @see wpmu_signup_user() for a full description of params.
+ *
+ * @param array $meta Signup meta data. Default empty array.
+ * @return array Signup meta data.
+ */
+function bp_core_add_meta_to_multisite_signups( $meta ) {
+
+    // Ensure that sent_date and count_sent are set in meta.
+    if ( ! isset( $meta['sent_date'] ) ) {
+        $meta['sent_date'] = '0000-00-00 00:00:00';
+    }
+    if ( ! isset( $meta['count_sent'] ) ) {
+        $meta['count_sent'] = 0;
+    }
+
+    return $meta;
+}
+add_filter( 'signup_user_meta', 'bp_core_add_meta_to_multisite_signups' );
+add_filter( 'signup_site_meta', 'bp_core_add_meta_to_multisite_signups' );
 
 /**

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

@@ -2389 +2389 @@
 
     // Record that the activation email has been sent.
-    $signups = BP_Signup::get(
-        array(
-            'activation_key' => $key,
-        )
-    );
-
-    if ( ! empty( $signups['signups'] ) ) {
-        foreach ( $signups['signups'] as $signup ) {
-            $meta = array(
-                'sent_date'  => current_time( 'mysql', true ),
-                'count_sent' => $signup->count_sent + 1
-            );
-
-            BP_Signup::update( array(
-                'signup_id' => $signup->id,
-                'meta'      => $meta,
-            ) );
-        }
+    $signup = bp_members_get_signup_by( 'activation_key', $key );
+
+    if ( $signup ) {
+        $meta = array(
+            'sent_date'  => current_time( 'mysql', true ),
+            'count_sent' => $signup->count_sent + 1
+        );
+
+        BP_Signup::update( array(
+            'signup_id' => $signup->id,
+            'meta'      => $meta,
+        ) );
     }
 }
@@ -3695 +3689 @@
     return apply_filters( 'bp_get_members_invitation_from_request', $invite );
 }
+
+/**
+ * Get WP_User object corresponding to a record in the signups table.
+ *
+ * @since 10.0.0
+ *
+ * @param string $field Which fields to search by. Possible values are
+ *                      activation_key, user_email, id.
+ * @param string $value Value to search by.
+ * @return bool|BP_Signup $signup Found signup, returns first found
+ *                                if more than one is found.
+ */
+function bp_members_get_signup_by( $field = 'activation_key', $value = '' ) {
+    switch ( $field ) {
+        case 'activation_key':
+        case 'user_email':
+            $key = $field;
+            break;
+
+        case 'id':
+        default:
+            $key = 'include';
+            break;
+    }
+
+    $signups = BP_Signup::get(
+        array(
+            $key => $value,
+        )
+    );
+
+    if ( ! empty( $signups['signups'] ) ) {
+        $signup = current( $signups['signups'] );
+    } else {
+        $signup = false;
+    }
+
+    return $signup;
+}
+
+/**
+ * Are site creation requests currently enabled?
+ *
+ * @since 10.0.0
+ *
+ * @return bool Whether site requests are currently enabled.
+ */
+function bp_members_site_requests_enabled() {
+
+    $matches = array( 'blog', 'all' );
+
+    return is_multisite() && in_array( bp_core_get_root_option( 'registration' ), $matches, true );
+}

trunk/src/bp-members/classes/class-bp-members-admin.php

@@ -2205 +2205 @@
 
         $signups    = $signups_query['signups'];
-        $signup_ids = wp_list_pluck( $signups, 'signup_id' );
+        $signup_ids = wp_list_pluck( $signups, 'id' );
 
         // Set up strings.

trunk/src/bp-members/classes/class-bp-signup.php

@@ -215 +215 @@
         }
 
-        /**
-         * Calculate a diff between now & last time
-         * an activation link has been resent.
-         */
-        $sent_at = mysql2date( 'U', $this->date_sent );
-        $now     = current_time( 'timestamp', true );
-        $diff    = $now - $sent_at;
-
-        /**
-         * Set a boolean to track whether an activation link
-         * was sent in the last day.
-         */
-        $this->recently_sent = ( $diff < 1 * DAY_IN_SECONDS );
-
         // How many times has the activation email been sent?
         if ( isset( $this->meta['count_sent'] ) ) {
             $this->count_sent = absint( $this->meta['count_sent'] );
         } else {
-            $this->count_sent = 0;
-        }
+            /**
+             * Meta will not be set if this is a pre-10.0 signup.
+             * In this case, we assume that the count is 1.
+             */
+            $this->count_sent = 1;
+        }
+
+        /**
+         * Calculate a diff between now & last time
+         * an activation link has been resent.
+         */
+        $sent_at = mysql2date( 'U', $this->date_sent );
+        $now     = current_time( 'timestamp', true );
+        $diff    = $now - $sent_at;
+
+        /**
+         * Set a boolean to track whether an activation link
+         * was sent in the last day.
+         */
+        $this->recently_sent = $this->count_sent && ( $diff < 1 * DAY_IN_SECONDS );
+
     }
 
@@ -815 +820 @@
         foreach ( $signups as $signup ) {
 
-            $meta = array(
-                'sent_date'  => current_time( 'mysql', true ),
-                'count_sent' => $signup->count_sent + 1
-            );
+            $meta               = $signup->meta;
+            $meta['sent_date']  = current_time( 'mysql', true );
+            $meta['count_sent'] = $signup->count_sent + 1;
 
             // Send activation email.
             if ( is_multisite() ) {
-                wpmu_signup_user_notification( $signup->user_login, $signup->user_email, $signup->activation_key, serialize( $meta ) );
+                // Should we send the user or blog activation email?
+                if ( ! empty( $signup->domain ) || ! empty( $signup->path ) ) {
+                    wpmu_signup_blog_notification( $signup->domain, $signup->path, $signup->title, $signup->user_login, $signup->user_email, $signup->activation_key, $meta );
+                } else {
+                    wpmu_signup_user_notification( $signup->user_login, $signup->user_email, $signup->activation_key, $meta );
+                }
             } else {