PHPMailer::wrapText( string $message, int $length, bool $qp_mode = false ): string

Description

Compatibility

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

Parameters

$messagestring

The message to wrap

$lengthint

The line length to wrap to

$qp_modebooloptional

Whether to run in Quoted-Printable modeDefault: false

Return value

string

Performance profile

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

34–41

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

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 · 1 distinct outcome

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

Uses · 2

• static::normalizeBreaks()
• \PHPMailer\PHPMailer\PHPMailer::utf8CharBoundary()

Source code

View on Trac ↗View on GitHub ↗

2682    public function wrapText($message, $length, $qp_mode = false)2683    {2684        if ($qp_mode) {2685            $soft_break = sprintf(' =%s', static::$LE);2686        } else {2687            $soft_break = static::$LE;2688        }2689        //If utf-8 encoding is used, we will need to make sure we don't2690        //split multibyte characters when we wrap2691        $is_utf8 = static::CHARSET_UTF8 === strtolower($this->CharSet);2692        $lelen = strlen(static::$LE);2693        $crlflen = strlen(static::$LE);2694 2695        $message = static::normalizeBreaks($message);2696        //Remove a trailing line break2697        if (substr($message, -$lelen) === static::$LE) {2698            $message = substr($message, 0, -$lelen);2699        }2700 2701        //Split message into lines2702        $lines = explode(static::$LE, $message);2703        //Message will be rebuilt in here2704        $message = '';2705        foreach ($lines as $line) {2706            $words = explode(' ', $line);2707            $buf = '';2708            $firstword = true;2709            foreach ($words as $word) {2710                if ($qp_mode && (strlen($word) > $length)) {2711                    $space_left = $length - strlen($buf) - $crlflen;2712                    if (!$firstword) {2713                        if ($space_left > 20) {2714                            $len = $space_left;2715                            if ($is_utf8) {2716                                $len = $this->utf8CharBoundary($word, $len);2717                            } elseif ('=' === substr($word, $len - 1, 1)) {2718                                --$len;2719                            } elseif ('=' === substr($word, $len - 2, 1)) {2720                                $len -= 2;2721                            }2722                            $part = substr($word, 0, $len);2723                            $word = substr($word, $len);2724                            $buf .= ' ' . $part;2725                            $message .= $buf . sprintf('=%s', static::$LE);2726                        } else {2727                            $message .= $buf . $soft_break;2728                        }2729                        $buf = '';2730                    }2731                    while ($word !== '') {2732                        if ($length <= 0) {2733                            break;2734                        }2735                        $len = $length;2736                        if ($is_utf8) {2737                            $len = $this->utf8CharBoundary($word, $len);2738                        } elseif ('=' === substr($word, $len - 1, 1)) {2739                            --$len;2740                        } elseif ('=' === substr($word, $len - 2, 1)) {2741                            $len -= 2;2742                        }2743                        $part = substr($word, 0, $len);2744                        $word = (string) substr($word, $len);2745 2746                        if ($word !== '') {2747                            $message .= $part . sprintf('=%s', static::$LE);2748                        } else {2749                            $buf = $part;2750                        }2751                    }2752                } else {2753                    $buf_o = $buf;2754                    if (!$firstword) {2755                        $buf .= ' ';2756                    }2757                    $buf .= $word;2758 2759                    if ('' !== $buf_o && strlen($buf) > $length) {2760                        $message .= $buf_o . $soft_break;2761                        $buf = $word;

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.