Changeset 13372 for trunk/src/bp-core/classes/class-bp-email.php
- Timestamp:
- 11/24/2022 09:33:11 PM (2 years ago)
- File:
-
- 1 edited
-
trunk/src/bp-core/classes/class-bp-email.php (modified) (17 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-core/classes/class-bp-email.php
r12932 r13372 199 199 * @since 2.5.0 200 200 * 201 * @param string $email_type Unique identifier for this type of email.202 * @param BP_Email $ thisCurrent instance of the email type class.201 * @param string $email_type Unique identifier for this type of email. 202 * @param BP_Email $email Current instance of the email type class. 203 203 */ 204 204 do_action( 'bp_email', $email_type, $this ); … … 245 245 * @since 2.5.0 246 246 * 247 * @param mixed $property_value Property value.248 * @param string $property_name249 * @param string $transformHow to transform the return value.250 * Accepts 'raw' (default) or 'replace-tokens'.251 * @param BP_Email $ thisCurrent instance of the email type class.247 * @param mixed $property_value Property value. 248 * @param string $property_name Property name. 249 * @param string $transform How to transform the return value. 250 * Accepts 'raw' (default) or 'replace-tokens'. 251 * @param BP_Email $email Current instance of the email type class. 252 252 */ 253 253 $retval = apply_filters( "bp_email_get_{$property_name}", $this->$property_name, $property_name, $transform, $this ); … … 273 273 * @since 2.5.0 274 274 * 275 * @param string $retvalProperty value.276 * @param string $property_name277 * @param string $transformHow to transform the return value.278 * Accepts 'raw' (default) or 'replace-tokens'.279 * @param BP_Email $ thisCurrent instance of the email type class.275 * @param string $retval Property value. 276 * @param string $property_name Property name. 277 * @param string $transform How to transform the return value. 278 * Accepts 'raw' (default) or 'replace-tokens'. 279 * @param BP_Email $email Current instance of the email type class. 280 280 */ 281 281 return apply_filters( 'bp_email_get_property', $retval, $property_name, $transform, $this ); … … 551 551 * 552 552 * @param string[] $new_headers Key/value pairs of new header name/values (strings). 553 * @param BP_Email $ thisCurrent instance of the email type class.553 * @param BP_Email $email Current instance of the email type class. 554 554 */ 555 555 $this->headers = apply_filters( 'bp_email_set_headers', $new_headers, $this ); … … 593 593 * @since 2.5.0 594 594 * 595 * @param BP_Email_Recipient[] $bccBCC recipients.595 * @param BP_Email_Recipient[] $bcc BCC recipients. 596 596 * @param string|array|int|WP_User $bcc_address Either a email address, user ID, WP_User object, 597 597 * or an array containing any combination of the above. 598 * @param string $name Optional. If $bcc_address is a string, this is the recipient's name. 599 * @param string $operation If "replace", $to_address replaced previous recipients. If "add", 600 * $to_address was added to the array of recipients. 601 * @param BP_Email $this Current instance of the email type class. 598 * @param string $name Optional. If $bcc_address is a string, this is the recipient's 599 * name. 600 * @param string $operation If "replace", $to_address replaced previous recipients. 601 * If "add", $to_address was added to the array of recipients. 602 * @param BP_Email $email Current instance of the email type class. 602 603 */ 603 604 $this->bcc = apply_filters( 'bp_email_set_bcc', $bcc, $bcc_address, $name, $operation, $this ); … … 641 642 * @since 2.5.0 642 643 * 643 * @param BP_Email_Recipient[] $ccCC recipients.644 * @param BP_Email_Recipient[] $cc CC recipients. 644 645 * @param string|array|int|WP_User $cc_address Either a email address, user ID, WP_User object, 645 646 * or an array containing any combination of the above. 646 * @param string $nameOptional. If $cc_address is a string, this is the recipient's name.647 * @param string $operationIf "replace", $to_address replaced previous recipients. If "add",648 * $to_address was added to the array of recipients.649 * @param BP_Email $thisCurrent instance of the email type class.647 * @param string $name Optional. If $cc_address is a string, this is the recipient's name. 648 * @param string $operation If "replace", $to_address replaced previous recipients. If "add", 649 * $to_address was added to the array of recipients. 650 * @param BP_Email $email Current instance of the email type class. 650 651 */ 651 652 $this->cc = apply_filters( 'bp_email_set_cc', $cc, $cc_address, $name, $operation, $this ); … … 669 670 * @since 2.5.0 670 671 * 671 * @param string $content HTML email content.672 * @param BP_Email $ thisCurrent instance of the email type class.672 * @param string $content HTML email content. 673 * @param BP_Email $email Current instance of the email type class. 673 674 */ 674 675 $this->content_html = apply_filters( 'bp_email_set_content_html', $content, $this ); … … 692 693 * @since 2.5.0 693 694 * 694 * @param string $content Plain text email content.695 * @param BP_Email $ thisCurrent instance of the email type class.695 * @param string $content Plain text email content. 696 * @param BP_Email $email Current instance of the email type class. 696 697 */ 697 698 $this->content_plaintext = apply_filters( 'bp_email_set_content_plaintext', $content, $this ); … … 721 722 * @since 2.5.0 722 723 * 723 * @param string $content_type Email content type ("html" or "plaintext").724 * @param BP_Email $ thisCurrent instance of the email type class.724 * @param string $content_type Email content type ("html" or "plaintext"). 725 * @param BP_Email $email Current instance of the email type class. 725 726 */ 726 727 $this->content_type = apply_filters( 'bp_email_set_content_type', $content_type, $this ); … … 749 750 * @since 2.5.0 750 751 * 751 * @param BP_Email_Recipient $fromSender details.752 * @param BP_Email_Recipient $from Sender details. 752 753 * @param string|array|int|WP_User $email_address Either a email address, user ID, or WP_User object. 753 * @param string $name Optional. If $email_address is a string, this is the recipient's name. 754 * @param BP_Email $this Current instance of the email type class. 754 * @param string $name Optional. If $email_address is a string, this is the 755 * recipient's name. 756 * @param BP_Email $email Current instance of the email type class. 755 757 */ 756 758 $this->from = apply_filters( 'bp_email_set_from', $from, $email_address, $name, $this ); … … 776 778 * @since 2.5.0 777 779 * 778 * @param WP_Post $postA Post.779 * @param BP_Email $ thisCurrent instance of the email type class.780 * @param WP_Post $post A Post. 781 * @param BP_Email $email Current instance of the email type class. 780 782 */ 781 783 $this->post_object = apply_filters( 'bp_email_set_post_object', $post, $this ); … … 832 834 * @since 2.5.0 833 835 * 834 * @param BP_Email_Recipient $reply_to"Reply to" recipient.836 * @param BP_Email_Recipient $reply_to "Reply to" recipient. 835 837 * @param string|array|int|WP_User $email_address Either a email address, user ID, WP_User object, 836 838 * or an array containing any combination of the above. 837 * @param string $name Optional. If $email_address is a string, this is the recipient's name. 838 * @param BP_Email $this Current instance of the email type class. 839 * @param string $name Optional. If $email_address is a string, this is the 840 * recipient's name. 841 * @param BP_Email $email Current instance of the email type class. 839 842 */ 840 843 $this->reply_to = apply_filters( 'bp_email_set_reply_to', $reply_to, $email_address, $name, $this ); … … 858 861 * @since 2.5.0 859 862 * 860 * @param string $subject Email subject.861 * @param BP_Email $ thisCurrent instance of the email type class.863 * @param string $subject Email subject. 864 * @param BP_Email $email Current instance of the email type class. 862 865 */ 863 866 $this->subject = apply_filters( 'bp_email_set_subject', $subject, $this ); … … 884 887 * @since 2.5.0 885 888 * 886 * @param string $template Email template. Assumed to be HTML.887 * @param BP_Email $ thisCurrent instance of the email type class.889 * @param string $template Email template. Assumed to be HTML. 890 * @param BP_Email $email Current instance of the email type class. 888 891 */ 889 892 $this->template = apply_filters( 'bp_email_set_template', $template, $this ); … … 932 935 * @since 2.5.0 933 936 * 934 * @param BP_Email_Recipient[] "To" recipients.935 * @param string $to_address "To" address.936 * @param string $name"To" name.937 * @param string $operationIf "replace", $to_address replaced previous recipients. If "add",938 * $to_address was added to the array of recipients.939 * @param BP_Email $thisCurrent instance of the email type class.937 * @param BP_Email_Recipient[] $to "To" recipients. 938 * @param string $to_address "To" address. 939 * @param string $name "To" name. 940 * @param string $operation If "replace", $to_address replaced previous recipients. If "add", 941 * $to_address was added to the array of recipients. 942 * @param BP_Email $email Current instance of the email type class. 940 943 */ 941 944 $this->to = apply_filters( 'bp_email_set_to', $to, $to_address, $name, $operation, $this ); … … 973 976 * @param string[] $tokens Associative pairing of unformatted token 974 977 * names (key) and replacement values (value). 975 * @param BP_Email $ thisCurrent instance of the email type class.978 * @param BP_Email $email Current instance of the email type class. 976 979 */ 977 980 $this->tokens = apply_filters( 'bp_email_set_tokens', $formatted_tokens, $tokens, $this ); … … 1022 1025 * 1023 1026 * @param bool|WP_Error $retval Returns true if validation succesful, else a descriptive WP_Error. 1024 * @param BP_Email $thisCurrent instance of the email type class.1027 * @param BP_Email $email Current instance of the email type class. 1025 1028 */ 1026 1029 return apply_filters( 'bp_email_validate', $retval, $this );
Note: See TracChangeset
for help on using the changeset viewer.