Changeset 12161

Timestamp:

10/31/2022 03:47:05 AM (3 years ago)

Author:

dd32

Message:

Support Forums: Create a user notes entry every time a user is flagged or unflagged.

This also adds a generic User_Notes function that updates the previous user-note if made within 5 minutes, as used by the forum role changer, so that the flagged/unflagged note is added to any recent descriptive reason.

Fixes #6554.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc

Files:

• class-hooks.php (modified) (2 diffs)
• class-user-notes.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-hooks.php

@@ -136 +136 @@
         add_filter( 'pre_oembed_result', array( $this, 'pre_oembed_result_dont_embed_wordpress_org_anchors' ), 20, 2 );
 
+        // Add a user note when flagging/unflagging a user.
+        add_filter( 'wporg_bbp_flag_user', array( $this, 'log_user_flag_changes' ) );
+        add_filter( 'wporg_bbp_unflag_user', array( $this, 'log_user_flag_changes' ) );
+
         // Break users sessions / passwords when they get blocked, on the main forums only.
         if ( 'wordpress.org' === get_blog_details()->domain ) {
@@ -1450 +1454 @@
         if ( $note_text ) {
             // Add a user note about this action.
-            $notes   = Plugin::get_instance()->user_notes->get_user_notes( $user->ID );
-            $note_id = 0;
-
-            // Check to see if the last note added was from the current user in the last few minutes, and if so, append to it.
-            if ( $notes->count ) {
-                $last_note_id = array_key_last( $notes->raw );
-                $last_note    = $notes->raw[ $last_note_id ];
-                if (
-                    // Note from the current user
-                    $last_note->moderator === wp_get_current_user()->user_nicename &&
-                    // ..and created within 5 minutes.
-                    absint( time() - strtotime( $last_note->date ) ) <= 5 * MINUTE_IN_SECONDS
-                ) {
-                    $note_id = $last_note_id;
-
-                    // Prefix the existing message.
-                    $note_text = trim( $last_note->text . "\n\n" . $note_text );
-                }
-            }
-
-            // Add a user note about this action.
-            Plugin::get_instance()->user_notes->add_user_note(
+            Plugin::get_instance()->user_notes->add_user_note_or_update_previous(
                 $user->ID,
-                $note_text,
-                null,
-                $note_id
+                $note_text
             );
         }
 
     }
+
+    /**
+     * Add a user note when a user is flagged / unflagged.
+     */
+    function log_user_flag_changes( $user_id ) {
+        $flag_action = ( 'wporg_bbp_flag_user' === current_filter () ) ? 'flaged' : 'unflagged';
+
+        $note_text = "User {$flag_action}.";
+
+        Plugin::get_instance()->user_notes->add_user_note_or_update_previous(
+            $user_id,
+            $note_text
+        );
+    }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php

@@ -147 +147 @@
 
     /**
+     * Saves a note to a users meta data. Suffixes to previous user note if by same moderator within a timeframe.
+     * 
+     * @param int    $user_id   The user ID.
+     * @param string $note_text The note text to add.
+     * @param int    $post_id   The support thread this text is related to. Optional.
+     * @param int    $timeframe The timeframe used to determine if the previous note should be updated. Optional. Default 5 minutes.
+     */
+    public function add_user_note_or_update_previous( $user_id, $note_text, $post_id = 0, $timeframe = 300 ) {
+        // Default to adding a new note..
+        $note_id = 0;
+
+        // Add a user note about this action.
+        $existing_notes = $this->get_user_notes( $user_id );
+
+        // Check to see if the last note added was from the current user in the last few minutes, and if so, append to it.
+        if ( $existing_notes->count ) {
+            $last_note_id = array_key_last( $existing_notes->raw );
+            $last_note    = $existing_notes->raw[ $last_note_id ];
+            if (
+                // Note from the current user
+                $last_note->moderator === wp_get_current_user()->user_nicename &&
+                // ..and created within $timeframe seconds
+                absint( time() - strtotime( $last_note->date ) ) <= $timeframe
+            ) {
+                $note_id = $last_note_id;
+
+                // Prefix the existing message.
+                $note_text = trim( $last_note->text . "\n\n" . $note_text );
+            }
+        }
+
+        return $this->add_user_note( $user_id, $note_text, $post_id, $note_id );
+    }
+
+    /**
      * Deletes a previously added note from user's meta data.
      *