wppaste
WordPress

PHPMailer::html2text( string $html, bool|callable $advanced = false ): string

Source
wp-includes/PHPMailer/PHPMailer.php:4845
Convert an HTML string into plain text.

Description

This is used by msgHTML().
Note - older versions of this function used a bundled advanced converter which was removed for license reasons in #232.
Example usage:

//Use default conversion
$plain = $mail->html2text($html);
//Use your own custom converter
$plain = $mail->html2text($html, function($html) {
 $converter = new MyHtml2text($html);
 return $converter->get_text();
});

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

$htmlstring
The HTML text to convert
$advancedbool|callableoptional
Any boolean value to use the internal converter, or provide your own callable for custom conversion.
Never pass user-supplied data into this parameterDefault: false

Return value

string

Performance profile

How much work a call to PHPMailer::html2text() 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
10–19

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

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

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

WhenInstructionsCalls it makes
is_callable()10is_callable(), call_user_func()
!is_callable()19is_callable(), strip_tags(), html_entity_decode()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev2310–191
8.52310–191
8.42310–1915 fewer instructions than PHP 8.3
8.32810–241
8.22810–241
8.12810–241
7.42810–241

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.

Source code

View on Trac View on GitHub 

    public function html2text($html, $advanced = false)    {        if (is_callable($advanced)) {            return call_user_func($advanced, $html);        }         return html_entity_decode(            trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/si', '', $html))),            ENT_QUOTES,            $this->CharSet        );    }

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.