BP_Email::validate()

Check that we’d be able to send this email.

Description

Unlike most other methods in this class, this one is not chainable.

Return

(bool|WP_Error) Returns true if validation succesful, else a descriptive WP_Error.

Source

File: bp-core/classes/class-bp-email.php

public function validate() {
    $retval = true;
 
    // BCC, CC, and token properties are optional.
    if (
        ! $this->get_from() ||
        ! $this->get_to() ||
        ! $this->get_subject() ||
        ! $this->get_content() ||
        ! $this->get_template()
    ) {
        $retval = new WP_Error( 'missing_parameter', __CLASS__, $this );
    }
 
    /**
     * Filters whether the email passes basic validation checks.
     *
     * @since BuddyPress 2.5.0
     *
     * @param bool|WP_Error $retval Returns true if validation succesful, else a descriptive WP_Error.
     * @param BP_Email $this Current instance of the email type class.
     */
    return apply_filters( 'bp_email_validate', $retval, $this );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.5.0	Introduced.

Uses

Uses
Uses	Description
bp-core/classes/class-bp-email.php: bp_email_validate	Filters whether the email passes basic validation checks.
bp-core/classes/class-bp-email.php: BP_Email::get_to()	Get the email’s “to” address and name.
bp-core/classes/class-bp-email.php: BP_Email::get_template()	Get the email template (the HTML wrapper around the email content).
bp-core/classes/class-bp-email.php: BP_Email::get_from()	Get the email’s “from” address and name.
bp-core/classes/class-bp-email.php: BP_Email::get_subject()	Get the email subject.
bp-core/classes/class-bp-email.php: BP_Email::get_content()	Get the email content.

Show 1 more use Hide more uses

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents