Changeset 10580

Timestamp:

01/14/2021 06:30:11 AM (4 years ago)

Author:

dd32

Message:

Support Forums: Add a user log entry when a user is blocked or unblocked.

See #4691.
See #2537.

Location:

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

Files:

• class-hooks.php (modified) (3 diffs)
• class-user-notes.php (modified) (8 diffs)

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

@@ -1285 +1285 @@
     /**
      * Catch a user being blocked / unblocked and set their password appropriately.
+     *
+     * Note: This method is called even when the users role is not changed.
      */
     public function user_blocked_password_handler( $new_role, $user_id, \WP_User $user ) {
@@ -1319 +1321 @@
             $manager->destroy_all();
 
+            // Add a user note about this action.
+            Plugin::get_instance()->user_notes->add_user_note(
+                $user->ID,
+                sprintf(
+                    'Forum role changed to %s.',
+                    get_role( $new_role )->name
+                )
+            );
         } else if (
             $password_broken &&
@@ -1336 +1346 @@
 
             clean_user_cache( $user );
-        }
+
+            // Add a user note about this action.
+            Plugin::get_instance()->user_notes->add_user_note(
+                $user->ID,
+                sprintf(
+                    'Forum role changed to %s.',
+                    get_role( $new_role )->name
+                )
+            );
+        }
+
     }
 }

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

@@ -22 +22 @@
         add_action( 'wp_enqueue_scripts',                   array( $this, 'enqueue_scripts' ) );
 
-        add_action( 'bbp_post_request',                     array( $this, 'add_user_note' ) );
-        add_action( 'bbp_get_request',                      array( $this, 'delete_user_note' ) );
+        add_action( 'bbp_post_request',                     array( $this, 'add_user_note_request' ) );
+        add_action( 'bbp_get_request',                      array( $this, 'delete_user_note_request' ) );
 
         add_action( 'bbp_theme_after_topic_author_details', array( $this, 'display_user_notes_toggle_link' ) );
@@ -49 +49 @@
      * @param string $action Requested action.
      */
-    public function add_user_note( $action = '' ) {
+    public function add_user_note_request( $action = '' ) {
         if ( 'wporg_bbp_add_user_note' !== $action || ! current_user_can( 'moderate' ) ) {
             return;
@@ -69 +69 @@
         }
 
+        $this->add_user_note( $user_id, $note_text, $post_id, $note_id );
+
+        $redirect_url = set_url_scheme( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
+
+        // Redirect to clear form data.
+        bbp_redirect( $redirect_url );
+    }
+
+    /**
+     * Saves a note to a users meta data.
+     * 
+     * @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    $note_id   The note ID to edit. Optional.
+     */
+    public function add_user_note( $user_id, $note_text, $post_id = 0, $note_id = 0 ) {
         // Make sure the user exists.
         $user = get_userdata( $user_id );
         if ( ! $user ) {
-            return;
+            return false;
         }
 
@@ -101 +118 @@
                 $user_notes[ $note_id ]->moderator !== wp_get_current_user()->user_nicename
             ) {
-                return;
+                return false;
             }
 
@@ -115 +132 @@
         update_user_meta( $user_id, self::META, $user_notes );
 
-        $redirect_url = set_url_scheme( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
-
-        // Redirect to clear form data.
-        bbp_redirect( $redirect_url );
+        return true;
     }
 
@@ -126 +140 @@
      * @param string $action Requested action.
      */
-    public function delete_user_note( $action = '' ) {
+    public function delete_user_note_request( $action = '' ) {
         if ( 'wporg_bbp_delete_user_note' !== $action || ! current_user_can( 'keep_gate' ) ) {
             return;
@@ -143 +157 @@
         }
 
+        $this->delete_user_note( $user_id, $note_id );
+
+        $redirect_url = remove_query_arg( array( 'action', 'user_id', 'note_id', '_wpnonce' ) );
+
+        // Redirect to clear URL.
+        bbp_redirect( $redirect_url );
+    }
+
+    /**
+     * Delete a user note.
+     *
+     * @param int $user_id The user ID.
+     * @param int $note_id The note ID.
+     */
+    public function delete_user_note( $user_id, $note_id ) {
         // Make sure the user exists.
         $user = get_userdata( $user_id );
         if ( ! $user ) {
-            return;
+            return false;
         }
 
         // Get an array of existing notes.
         $user_notes = get_user_meta( $user_id, self::META, true );
-        if ( ! $user_notes ) {
-            return;
+        if ( ! $user_notes || ! isset( $user_notes[ $note_id ] ) ) {
+            return false;
         }
 
@@ -164 +193 @@
         update_user_meta( $user_id, self::META, $user_notes );
 
-        $redirect_url = remove_query_arg( array( 'action', 'user_id', 'note_id', '_wpnonce' ) );
-
-        // Redirect to clear URL.
-        bbp_redirect( $redirect_url );
+        return true;
     }