wppaste
WordPress

PHPMailer::edebug( string $str )

Source
wp-includes/PHPMailer/PHPMailer.php:912
Output debugging info via a user-defined method.

Description

Only generates output if debug output is enabled.

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

Performance profile

How much work a call to PHPMailer::edebug() 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
5–39

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

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

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

WhenInstructionsCalls it makes
always5none
$value instanceof16rtrim(), ->debug()
!($value instanceof)20–25is_callable(), error_log()
!($value instanceof) && is_callable()22is_callable(), call_user_func()
!($value instanceof)26–33is_callable(), htmlentities()
!($value instanceof)30–39is_callable(), gmdate()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev705–397
8.5705–397
8.4705–39713 fewer instructions than PHP 8.3
8.3835–497
8.2835–497
8.1835–497
7.4835–497

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

    protected function edebug($str)    {        if ($this->SMTPDebug <= 0) {            return;        }        //Is this a PSR-3 logger?        if ($this->Debugoutput instanceof \Psr\Log\LoggerInterface) {            $this->Debugoutput->debug(rtrim($str, "\r\n"));             return;        }        //Avoid clash with built-in function names        if (is_callable($this->Debugoutput) && !in_array($this->Debugoutput, ['error_log', 'html', 'echo'])) {            call_user_func($this->Debugoutput, $str, $this->SMTPDebug);             return;        }        switch ($this->Debugoutput) {            case 'error_log':                //Don't output, just log                /** @noinspection ForgottenDebugOutputInspection */                error_log($str);                break;            case 'html':                //Cleans up output a bit for a better looking, HTML-safe output                echo htmlentities(                    preg_replace('/[\r\n]+/', '', $str),                    ENT_QUOTES,                    'UTF-8'                ), "<br>\n";                break;            case 'echo':            default:                //Normalize line breaks                $str = preg_replace('/\r\n|\r/m', "\n", $str);                echo gmdate('Y-m-d H:i:s'),                "\t",                    //Trim trailing space                trim(                    //Indent for readability, except for trailing break                    str_replace(                        "\n",                        "\n                   \t                  ",                        trim($str)                    )                ),                "\n";        }    }

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.