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

Timestamp:

01/10/2018 12:44:33 PM (8 years ago)

Author:

djpaul

Message:

Members: add "IDs only" return format option for BP_Signup::get().

Fixes #7641

Props espellcaste

File:

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

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

@@ -133 +133 @@
      *     @type string      $activation_key Activation key to search for.
      *     @type string      $user_login     Specific user login to return.
+     *     @type string      $fields         Which fields to return. Specify 'ids' to fetch a list of signups IDs.
+     *                                       Default: 'all' (return BP_Signup objects).
      * }
      * @return array {
-     *     @type array $signups Located signups.
+     *     @type array $signups Located signups. (IDs only if `fields` is set to `ids`.)
      *     @type int   $total   Total number of signups matching params.
      * }
@@ -152 +154 @@
                 'activation_key' => '',
                 'user_login'     => '',
+                'fields'         => 'all',
             ),
             'bp_core_signups_get_args'
@@ -214 +217 @@
         }
 
-        // Used to calculate a diff between now & last
-        // time an activation link has been resent.
-        $now = current_time( 'timestamp', true );
-
-        foreach ( (array) $paged_signups as $key => $signup ) {
-
-            $signup->id   = intval( $signup->signup_id );
-
-            $signup->meta = ! empty( $signup->meta ) ? maybe_unserialize( $signup->meta ) : false;
-
-            $signup->user_name = '';
-            if ( ! empty( $signup->meta['field_1'] ) ) {
-                $signup->user_name = wp_unslash( $signup->meta['field_1'] );
+        // We only want the IDs.
+        if ( 'ids' === $r['fields'] ) {
+            $paged_signups = wp_list_pluck( $paged_signups, 'signup_id' );
+        } else {
+
+            // Used to calculate a diff between now & last
+            // time an activation link has been resent.
+            $now = current_time( 'timestamp', true );
+
+            foreach ( (array) $paged_signups as $key => $signup ) {
+
+                $signup->id   = intval( $signup->signup_id );
+
+                $signup->meta = ! empty( $signup->meta ) ? maybe_unserialize( $signup->meta ) : false;
+
+                $signup->user_name = '';
+                if ( ! empty( $signup->meta['field_1'] ) ) {
+                    $signup->user_name = wp_unslash( $signup->meta['field_1'] );
+                }
+
+                // Sent date defaults to date of registration.
+                if ( ! empty( $signup->meta['sent_date'] ) ) {
+                    $signup->date_sent = $signup->meta['sent_date'];
+                } else {
+                    $signup->date_sent = $signup->registered;
+                }
+
+                $sent_at = mysql2date('U', $signup->date_sent );
+                $diff    = $now - $sent_at;
+
+                /**
+                 * Add a boolean in case the last time an activation link
+                 * has been sent happened less than a day ago.
+                 */
+                if ( $diff < 1 * DAY_IN_SECONDS ) {
+                    $signup->recently_sent = true;
+                }
+
+                if ( ! empty( $signup->meta['count_sent'] ) ) {
+                    $signup->count_sent = absint( $signup->meta['count_sent'] );
+                } else {
+                    $signup->count_sent = 1;
+                }
+
+                $paged_signups[ $key ] = $signup;
             }
-
-            // Sent date defaults to date of registration.
-            if ( ! empty( $signup->meta['sent_date'] ) ) {
-                $signup->date_sent = $signup->meta['sent_date'];
-            } else {
-                $signup->date_sent = $signup->registered;
-            }
-
-            $sent_at = mysql2date('U', $signup->date_sent );
-            $diff    = $now - $sent_at;
-
-            /**
-             * Add a boolean in case the last time an activation link
-             * has been sent happened less than a day ago.
-             */
-            if ( $diff < 1 * DAY_IN_SECONDS ) {
-                $signup->recently_sent = true;
-            }
-
-            if ( ! empty( $signup->meta['count_sent'] ) ) {
-                $signup->count_sent = absint( $signup->meta['count_sent'] );
-            } else {
-                $signup->count_sent = 1;
-            }
-
-            $paged_signups[ $key ] = $signup;
         }
 
@@ -272 +281 @@
 
         return array( 'signups' => $paged_signups, 'total' => $total_signups );
-
     }