[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-core/classes/ -> class-bp-email-recipient.php (summary)

Core component classes.

File Size: 179 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_Email_Recipient:: (4 methods):
  __construct()
  get_address()
  get_name()
  get_user()


Class: BP_Email_Recipient  - X-Ref

Represents a recipient that an email will be sent to.

__construct( $email_or_user, $name = '' )   X-Ref
Constructor.

since: 2.5.0
param: string|array|int|WP_User $email_or_user Either a email address, user ID, WP_User object,
param: string $name Optional. If $email_or_user is a string, this is the recipient's name.

get_address()   X-Ref
Get recipient's address.

since: 2.5.0
return: string

get_name()   X-Ref
Get recipient's name.

since: 2.5.0
return: string

get_user( $transform = 'raw' )   X-Ref
Get WP_User object for this recipient.

since: 2.5.0
return: WP_User|null WP_User object, or null if not set.
param: string $transform Optional. How to transform the return value.



Generated: Sat Sep 21 01:01:46 2019 Cross-referenced by PHPXref 0.7.1