PHPMailer::encodeString( string $str, string $encoding = self::ENCODING_BASE64 ): string
- Source
wp-includes/PHPMailer/PHPMailer.php:3676
Description
Returns an empty string on failure.
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
$strstring- The text to encode
$encodingstringoptional- The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'Default:
self::ENCODING_BASE64
Return value
string
Performance profile
How much work a call to PHPMailer::encodeString() 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
- 22–39
- 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 74.
Nothing here hands control to plugin code.
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::encodeString() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 22 | strtolower() |
| always | 23 | strtolower(), base64_encode(), chunk_split() |
| always | 25–31 | strtolower(), ::normalizeBreaks() |
| always | 28 | strtolower(), ->encodeQP() |
| always | 33 | strtolower(), ::lang(), ->setError() |
| always | 39 | strtolower(), ::lang(), ->setError(), ::lang() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 74 | 22–39 | 7 | |
| 8.5 | 74 | 22–39 | 7 | |
| 8.4 | 74 | 22–39 | 7 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 77 | 22–39 | 7 | |
| 8.2 | 77 | 22–39 | 7 | 1 more instruction than PHP 8.1 |
| 8.1 | 76 | 22–38 | 7 | |
| 7.4 | 76 | 22–38 | 7 |
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
- static::normalizeBreaks()
- \PHPMailer\PHPMailer\PHPMailer::encodeQP()
- \PHPMailer\PHPMailer\PHPMailer::setError()
- \PHPMailer\PHPMailer\PHPMailer::lang()
- \PHPMailer\PHPMailer\Exception::__construct()
Source code
public function encodeString($str, $encoding = self::ENCODING_BASE64) { $encoded = ''; switch (strtolower($encoding)) { case static::ENCODING_BASE64: $encoded = chunk_split( base64_encode($str), static::STD_LINE_LENGTH, static::$LE ); break; case static::ENCODING_7BIT: case static::ENCODING_8BIT: $encoded = static::normalizeBreaks($str); //Make sure it ends with a line break if (substr($encoded, -(strlen(static::$LE))) !== static::$LE) { $encoded .= static::$LE; } break; case static::ENCODING_BINARY: $encoded = $str; break; case static::ENCODING_QUOTED_PRINTABLE: $encoded = $this->encodeQP($str); break; default: $this->setError(self::lang('encoding') . $encoding); if ($this->exceptions) { throw new Exception(self::lang('encoding') . $encoding); } break; } return $encoded; }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.