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

Timestamp:

11/24/2022 09:33:11 PM (2 years ago)

Author:

imath

Message:

Replace usage of $this in @param tags with a meaningful variable name

Props devutpol, espellcaste

Fixes #8611

File:

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

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

@@ -33 +33 @@
      * @param string|array|int|WP_User $email_or_user Either a email address, user ID, WP_User object,
      *                                                or an array containing any combination of the above.
-     * @param string $name Optional. If $email_or_user is a string, this is the recipient's name.
+     * @param string                   $name          Optional. If $email_or_user is a string, this is the
+     *                                                recipient's name.
      */
     public function __construct( $email_or_user, $name = '' ) {
@@ -101 +102 @@
          * @param string|array|int|WP_User $email_or_user Either a email address, user ID, WP_User object,
          *                                                or an array containing any combination of the above.
-         * @param string $name If $email_or_user is a string, this is the recipient's name.
-         * @param BP_Email_Recipient $this Current instance of the email type class.
+         * @param string                   $name          If $email_or_user is a string, this is the recipient's name.
+         * @param BP_Email_Recipient       $recipient     Current instance of the email type class.
          */
         do_action( 'bp_email_recipient', $email_or_user, $name, $this );
@@ -170 +171 @@
          * @since 2.5.0
          *
-         * @param WP_User $name WP_User object for this recipient, or null if not set.
-         * @param string $transform Optional. How the return value was transformed.
-         *                          Accepts 'raw' (default) or 'search-email'.
-         * @param BP_Email $recipient $this Current instance of the email recipient class.
+         * @param WP_User            $user_object WP_User object for this recipient, or null if not set.
+         * @param string             $transform   Optional. How the return value was transformed.
+         *                                        Accepts 'raw' (default) or 'search-email'.
+         * @param BP_Email_Recipient $recipient   Current instance of the email recipient class.
          */
         return apply_filters( 'bp_email_recipient_get_user', $this->user_object, $transform, $this );