PHPMailer::addStringEmbeddedImage( string $string, string $cid, string $name = '', string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'inline' ): bool
- Source
wp-includes/PHPMailer/PHPMailer.php:4134
Description
This can include images, sounds, and just about any other document type.
If your filename doesn't contain an extension, be sure to set the $type to an appropriate MIME type.
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
$stringstring- The attachment binary data
$cidstring- Content ID of the attachment; Use this to reference the content when using an embedded image in HTML
$namestringoptional- A filename for the attachment. If this contains an extension, PHPMailer will attempt to set a MIME type for the attachment.
For example 'file.jpg' would get an 'image/jpeg' MIME type.Default:'' $encodingstringoptional- File encoding (see $Encoding), defaults to 'base64'Default:
self::ENCODING_BASE64 $typestringoptional- MIME type - will be used in preference to any automatically derived typeDefault:
'' $dispositionstringoptional- Disposition to useDefault:
'inline'
Return value
bool- True on successfully adding an attachment
Performance profile
How much work a call to PHPMailer::addStringEmbeddedImage() 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
- Scaling
- Constant
- Instructions
- 20–30
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 53.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost PHPMailer::addStringEmbeddedImage() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->validateEncoding() | 20–22 | ->validateEncoding(), ::lang() |
->validateEncoding() | 24–26 | ->validateEncoding() |
$type === "" && !empty($name) && !->validateEncoding() | 26 | ::filenameToType(), ->validateEncoding(), ::lang() |
$type === "" && !empty($name) && ->validateEncoding() | 30 | ::filenameToType(), ->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: 53 instructions, 20–30 executed per call, 4 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 · 6
- static::filenameToType()
- \PHPMailer\PHPMailer\PHPMailer::validateEncoding()
- \PHPMailer\PHPMailer\Exception::__construct()
- \PHPMailer\PHPMailer\PHPMailer::lang()
- \PHPMailer\PHPMailer\PHPMailer::setError()
- \PHPMailer\PHPMailer\PHPMailer::edebug()
Source code
public function addStringEmbeddedImage( $string, $cid, $name = '', $encoding = self::ENCODING_BASE64, $type = '', $disposition = 'inline' ) { try { //If a MIME type is not specified, try to work it out from the name if ('' === $type && !empty($name)) { $type = static::filenameToType($name); } if (!$this->validateEncoding($encoding)) { throw new Exception(self::lang('encoding') . $encoding); } //Append to $attachment array $this->attachment[] = [ 0 => $string, 1 => $name, 2 => $name, 3 => $encoding, 4 => $type, 5 => true, //isStringAttachment 6 => $disposition, 7 => $cid, ]; } 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.
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.