wppaste
WordPress

PHPMailer::addAttachment( string $path, string $name = '', string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'attachment' ): bool

Source
wp-includes/PHPMailer/PHPMailer.php:3462
Add an attachment from a path on the filesystem.

Description

Never use a user-supplied path to a file! Returns false if the file could not be found or read.
Explicitly does not support passing URLs; PHPMailer is not an HTTP client.
If you need to do that, fetch the resource yourself and pass it in via a local file or string.

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

$pathstring
Path to the attachment
$namestringoptional
Overrides the attachment nameDefault: ''
$encodingstringoptional
File encoding (see $Encoding)Default: self::ENCODING_BASE64
$typestringoptional
MIME type, e.g. image/jpeg; determined automatically from $path if not specifiedDefault: ''
$dispositionstringoptional
Disposition to useDefault: 'attachment'

Return value

bool

Performance profile

How much work a call to PHPMailer::addAttachment() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
19–40

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

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 · 5 distinct outcomes

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

WhenInstructionsCalls it makes
!::fileIsAccessible()19::fileIsAccessible(), ::lang()
::fileIsAccessible() && $type !== "" && !->validateEncoding()31–32::fileIsAccessible(), ::mb_pathinfo(), ->validateEncoding(), ::lang()
::fileIsAccessible() && $type !== "" && ->validateEncoding()35–36::fileIsAccessible(), ::mb_pathinfo(), ->validateEncoding()
::fileIsAccessible() && $type === "" && !->validateEncoding()35–36::fileIsAccessible(), ::filenameToType(), ::mb_pathinfo(), ->validateEncoding(), ::lang()
::fileIsAccessible() && $type === "" && ->validateEncoding()39–40::fileIsAccessible(), ::filenameToType(), ::mb_pathinfo(), ->validateEncoding()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 73 instructions, 19–40 executed per call, 5 branches. The work does not change between versions.

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 · 8

  • static::fileIsAccessible()
  • \PHPMailer\PHPMailer\Exception::__construct()
  • \PHPMailer\PHPMailer\PHPMailer::lang()
  • static::filenameToType()
  • static::mb_pathinfo()
  • \PHPMailer\PHPMailer\PHPMailer::validateEncoding()
  • \PHPMailer\PHPMailer\PHPMailer::setError()
  • \PHPMailer\PHPMailer\PHPMailer::edebug()

Source code

View on Trac View on GitHub 

    public function addAttachment(        $path,        $name = '',        $encoding = self::ENCODING_BASE64,        $type = '',        $disposition = 'attachment'    ) {        try {            if (!static::fileIsAccessible($path)) {                throw new Exception(self::lang('file_access') . $path, self::STOP_CONTINUE);            }             //If a MIME type is not specified, try to work it out from the file name            if ('' === $type) {                $type = static::filenameToType($path);            }             $filename = (string) static::mb_pathinfo($path, PATHINFO_BASENAME);            if ('' === $name) {                $name = $filename;            }            if (!$this->validateEncoding($encoding)) {                throw new Exception(self::lang('encoding') . $encoding);            }             $this->attachment[] = [                0 => $path,                1 => $filename,                2 => $name,                3 => $encoding,                4 => $type,                5 => false, //isStringAttachment                6 => $disposition,                7 => $name,            ];        } catch (Exception $exc) {            $this->setError($exc->getMessage());            $this->edebug($exc->getMessage());            if ($this->exceptions) {                throw $exc;            }             return false;        }         return true;    }

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.