Changeset 13892 for trunk/src/bp-core/classes/class-bp-email-recipient.php

Timestamp:

06/02/2024 01:16:13 AM (14 months ago)

Author:

espellcaste

Message:

WPCS: Part VI: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], [13887], [13888], and [13891]

See #9164 and #7228

File:

• trunk/src/bp-core/classes/class-bp-email-recipient.php (modified) (6 diffs)

trunk/src/bp-core/classes/class-bp-email-recipient.php

@@ -1 +1 @@
 <?php
 /**
- * Core component classes.
+ * BuddyPress Email Recipient class.
+ *
+ * Represents a recipient that an email will be sent to.
  *
  * @package BuddyPress
@@ -7 +9 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
 /**
- * Represents a recipient that an email will be sent to.
+ * BP_Email_Recipient class.
  *
  * @since 2.5.0
@@ -22 +24 @@
      * @since 2.5.0
      *
-     * @var WP_User
+     * @var WP_User|null
      */
     protected $user_object = null;
@@ -45 +47 @@
                 $this->user_object = $email_or_user;
 
-            // Query for WP user by user ID.
+                // Query for WP user by user ID.
             } elseif ( is_int( $email_or_user ) ) {
                 $this->user_object = get_user_by( 'id', $email_or_user );
@@ -55 +57 @@
             }
 
-        // Array or miscellaneous string.
+            // Array or miscellaneous string.
         } else {
             if ( ! is_array( $email_or_user ) ) {
@@ -82 +84 @@
         // We have a user object; so set address and name from DB.
         if ( $this->user_object ) {
-            // This is escaped with esc_html in bp_core_get_user_displayname()
+            // This is escaped with esc_html in bp_core_get_user_displayname().
             $wp_name = wp_specialchars_decode( bp_core_get_user_displayname( $this->user_object->ID ), ENT_QUOTES );