BP_Email::set_headers( string[] $headers )

Set email headers.

Description

Does NOT let you override to/from, etc. Use the methods provided to set those.

Parameters

$headers: (Required) Key/value pairs of header name/values (strings).

Return

(BP_Email)

Source

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

public function set_headers( array $headers ) {
    $new_headers = array();
 
    foreach ( $headers as $name => $content ) {
        $content = str_replace( ':', '', $content );
        $name    = str_replace( ':', '', $name );
 
        $new_headers[ sanitize_key( $name ) ] = sanitize_text_field( $content );
    }
 
    /**
     * Filters the new value of the email's "headers" property.
     *
     * @since BuddyPress 2.5.0
     *
     * @param string[] $new_headers Key/value pairs of new header name/values (strings).
     * @param BP_Email $this Current instance of the email type class.
     */
    $this->headers = apply_filters( 'bp_email_set_headers', $new_headers, $this );
 
    return $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_set_headers	Filters the new value of the email’s “headers” property.

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