wppaste
WordPress

PHPMailer::addAnAddress( string $kind, string $address, string $name = '' ): bool

Source
wp-includes/PHPMailer/PHPMailer.php:1224
Add an address to one of the recipient arrays or to the ReplyTo array.

Description

Addresses that have been added already return false, but do not throw exceptions.

Compatibility

WordPress
core
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$kindstring
One of 'to', 'cc', 'bcc', or 'ReplyTo'
$addressstring
The email address to send, resp. to reply to
$namestringoptional
Default: ''

Return value

bool
true on success, false if address already used or invalid in some way

Performance profile

How much work a call to PHPMailer::addAnAddress() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
21–39

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 99.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost PHPMailer::addAnAddress() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
$kind && ::validateAddress() && $kind !== "Reply-To"21–28::validateAddress(), strtolower()
$kind && ::validateAddress() && $kind === "Reply-To"23–31::validateAddress()
!$kind23–33::lang(), ->setError(), ->edebug()
$kind && ::validateAddress() && $kind === "Reply-To"26–33::validateAddress(), strcasecmp()
$kind && !::validateAddress()29–39::validateAddress(), ::lang(), ->setError(), ->edebug()
$kind && ::validateAddress() && $kind !== "Reply-To"32–39::validateAddress(), strtolower(), strtolower()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev9921–3911
8.59921–3911
8.49921–39118 fewer instructions than PHP 8.3
8.310721–4411
8.210721–4411
8.110721–4411
7.410721–4411

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 5

  • \PHPMailer\PHPMailer\PHPMailer::lang()
  • \PHPMailer\PHPMailer\PHPMailer::setError()
  • \PHPMailer\PHPMailer\PHPMailer::edebug()
  • \PHPMailer\PHPMailer\Exception::__construct()
  • static::validateAddress()

Source code

View on Trac View on GitHub 

    protected function addAnAddress($kind, $address, $name = '')    {        if (            self::$validator === 'php' &&            ((bool) preg_match('/[\x80-\xFF]/', $address))        ) {            //The caller has not altered the validator and is sending to an address            //with UTF-8, so assume that they want UTF-8 support instead of failing            $this->CharSet = self::CHARSET_UTF8;            self::$validator = 'eai';        }        if (!in_array($kind, ['to', 'cc', 'bcc', 'Reply-To'])) {            $error_message = sprintf(                '%s: %s',                self::lang('Invalid recipient kind'),                $kind            );            $this->setError($error_message);            $this->edebug($error_message);            if ($this->exceptions) {                throw new Exception($error_message);            }             return false;        }        if (!static::validateAddress($address)) {            $error_message = sprintf(                '%s (%s): %s',                self::lang('invalid_address'),                $kind,                $address            );            $this->setError($error_message);            $this->edebug($error_message);            if ($this->exceptions) {                throw new Exception($error_message);            }             return false;        }        if ('Reply-To' !== $kind) {            if (!array_key_exists(strtolower($address), $this->all_recipients)) {                $this->{$kind}[] = [$address, $name];                $this->all_recipients[strtolower($address)] = true;                 return true;            }        } else {            foreach ($this->ReplyTo as $replyTo) {                if (0 === strcasecmp($replyTo[0], $address)) {                    return false;                }            }            $this->ReplyTo[] = [$address, $name];             return true;        }        return false;    }

Changelog

Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/PHPMailer/PHPMailer.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.