Changeset 12122

Timestamp:

10/13/2022 06:00:30 AM (2 years ago)

Author:

dd32

Message:

Profile Helpers: Allow for assign_badge() to be passed an array of user IDs.

See r12121

File:

• sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php (modified) (4 diffs)

sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php

@@ -15 +15 @@
  * 
  * @param $badge string The badge group to assign.
- * @param $user  mixed  The user to assign.
+ * @param $users mixed  The user(s) to assign. A WP_User/ID/Login/Email (or array of) of the user(s) to assign.
  * @return bool
  */
-function assign_badge( string $badge, $user ) : bool {
-    return badge_api( 'add', $badge, $user );
+function assign_badge( string $badge, $users ) : bool {
+    return badge_api( 'add', $badge, $users );
 }
 
@@ -26 +26 @@
  * 
  * @param $badge string The badge group to assign.
- * @param $user  mixed  The user to assign.
+ * @param $users mixed  The user(s) to assign. A WP_User/ID/Login/Email (or array of) of the user(s) to assign.
  * @return bool
  */
-function remove_badge( string $badge, $user ) : bool {
-    return badge_api( 'remove', $badge, $user );
+function remove_badge( string $badge, $users ) : bool {
+    return badge_api( 'remove', $badge, $users );
+}
+
+/**
+ * Record an activity item for a user.
+ * 
+ * @param $component string     The component to be used for the acitivity.
+ * @param $type      string     The type of the activity in that component.
+ * @param $user      int|string ID, Login, or Slug of user.
+ * @param $args      array      The args for the activity item. See `bp_activity_add()`.
+ */
+function add_activity( string $component, string $type, $user, array $args ) {
+    $request = api( [
+        'action'    => 'wporg_handle_activity',
+        'source'    => 'generic',
+        'component' => $component,
+        'type'      => $type,
+        'user'      => $user,
+        'args'      => $args,
+    ] );
+
+    return ( 200 === wp_remote_retrieve_response_code( $request ) );
 }
 
@@ -36 +57 @@
  * Assign a badge to a given user.
  * 
- * @param $action string 'Add' or 'Remove'.
+ * @param $action string The action to perform; 'add' or 'remove'.
  * @param $badge  string The badge group to assign.
- * @param $user   mixed  The user to assign to.
+ * @param $users  mixed  The user(s) to assign to. A WP_User/ID/Login/Email/Slug (or array of) of the user(s) to assign.
  * @return bool
  */
-function badge_api( string $action, string $badge, $user ) : bool {
-    if ( is_object( $user ) && isset( $user->ID ) ) {
-        $user = $user->ID;
-    }
+function badge_api( string $action, string $badge, $users ) : bool {
+    $users = (array) $users;
+    $users = array_filter( array_map( function( $user ) {
+        // WP_User-like object.
+        if ( is_object( $user ) ) {
+            return $user->ID ?? false;
+        }
 
-    if ( ! $action || ! $badge || ! is_scalar( $user ) ) {
+        // User ID.
+        if ( is_numeric( $user ) && absint( $user ) == $user ) {
+            return (int) $user;
+        }
+
+        // Support user login / email / slug.
+        $_user = get_user_by( 'login', $user );
+        if ( ! $_user && is_email( $user ) ) {
+            $_user = get_user_by( 'email', $user );
+        }
+        if ( ! $_user ) {
+            $_user = get_user_by( 'slug', $user );
+        }
+
+        return $_user->ID ?? false;
+    }, $users ) );
+
+    if ( ! $action || ! $badge || ! $users ) {
         return false;
     }
@@ -54 +95 @@
         'source'  => 'generic-badge',
         'command' => $action,
-        'user'    => $user,
+        'users'   => $users,
         'badge'   => $badge,
     ] );