Changeset 14071 for trunk/src/bp-members/classes/class-bp-signup.php

Timestamp:

11/03/2024 06:44:17 PM (22 months ago)

Author:

espellcaste

Message:

Misc changes to the signups and pending accounts.

We are improving how signups and pending accounts are handled in BuddyPress.

• activation emails resend are blocked for one hour, by default;
• emails are checked if they are already in use in a signup;
• signup endpoint (​https://developer.buddypress.org/bp-rest-api/reference/signup/) returns a useful error when feature is disabled;
• Signup::resend: Added the ability to resend to a single ID, instead of an array of IDs.

Props niftythree and imath.

Closes ​https://github.com/buddypress/buddypress/pull/396
See #9229 and #9145
Fixes #9137

File:

• trunk/src/bp-members/classes/class-bp-signup.php (modified) (8 diffs)

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

@@ -4 +4 @@
  *
  * @package BuddyPress
- * @subpackage coreClasses
+ * @subpackage Signup
  * @since 2.0.0
  */
@@ -160 +160 @@
          * @since 2.0.0
          *
-         * @param integer $signup_id The ID for the signup being queried.
+         * @param int $signup_id The ID for the signup being queried.
          */
         public function __construct( $signup_id = 0 ) {
@@ -249 +249 @@
                  * was sent in the last day.
                  */
-                $this->recently_sent = $this->count_sent && ( $diff < 1 * DAY_IN_SECONDS );
-
+                $this->recently_sent = $this->count_sent && ( $diff < DAY_IN_SECONDS );
         }
 
@@ -827 +826 @@
          *
          * @since 2.0.0
-         *
-         * @param array $signup_ids Single ID or list of IDs to resend.
+         * @since 15.0.0 Added the ability to resend to a single ID.
+         *
+         * @param array|int $signup_ids Single ID or list of IDs to resend.
          * @return array
          */
         public static function resend( $signup_ids = array() ) {
-                if ( empty( $signup_ids ) || ! is_array( $signup_ids ) ) {
-                        return false;
+                if ( empty( $signup_ids ) ) {
+                        return array();
+                }
+
+                if ( ! is_array( $signup_ids ) ) {
+                        $signup_ids = array( $signup_ids );
                 }
 
                 $to_resend = self::get(
                         array(
-                                'include' => $signup_ids,
+                                'include' => wp_parse_id_list( $signup_ids ),
                         )
                 );
 
-                if ( ! $signups = $to_resend['signups'] ) {
-                        return false;
+                $signups = $to_resend['signups'];
+
+                if ( ! $signups ) {
+                        return array();
                 }
 
@@ -876 +882 @@
                                 $user_id = email_exists( $signup->user_email );
 
-                                if ( ! empty( $user_id ) && 2 != self::check_user_status( $user_id ) ) {
+                                if ( ! empty( $user_id ) && 2 !== self::check_user_status( $user_id ) ) {
 
                                         // Status is not 2, so user's account has been activated.
@@ -886 +892 @@
                                         continue;
 
-                                // Send the validation email.
+                                        // Send the validation email.
                                 } else {
                                         $salutation = $signup->user_login;
@@ -907 +913 @@
 
                 /**
-                 * Fires after activation emails are resent.
+                 * Fires after activation email(s) are/is resent.
                  *
                  * @since 2.0.0
@@ -924 +930 @@
                  */
                 return apply_filters( 'bp_core_signup_resend', $result );
+        }
+
+        /**
+         * Check if an activation email can be resent.
+         *
+         * @since 15.0.0
+         *
+         * @param BP_Signup $signup The signup object.
+         * @return bool
+         */
+        public static function allow_activation_resend( $signup ) {
+
+                // Bail if the signup is not a BP_Signup object.
+                if ( ! $signup instanceof BP_Signup ) {
+                        return false;
+                }
+
+                // Allow the activation email to be sent if not already.
+                if ( ! $signup->recently_sent || ! $signup->count_sent ) {
+                        return true;
+                }
+
+                $sent_at = mysql2date( 'U', $signup->date_sent );
+                $now     = time();
+                $diff    = $now - $sent_at;
+
+                /**
+                 * Filters the lock time for the resend activation.
+                 *
+                 * @since 15.0.0
+                 *
+                 * @param float|int $lock_time The lock time for the resend activation. Default: 1 hour.
+                 * @param BP_Signup $signup The signup object.
+                 */
+                $lock_time = apply_filters( 'bp_core_signup_resend_activation_lock_time', HOUR_IN_SECONDS, $signup );
+
+                // If the activation email was sent less than the lock time ago.
+                return false === ( $diff < $lock_time );
         }