PHPMailer::sanitiseDate( DateTime|DateTimeImmutable|string $date ): string
- Source
wp-includes/PHPMailer/PHPMailer.php:4477
Description
Accepts:
- A \DateTime (or \DateTimeImmutable) object
- Any date/time string understood by PHP's DateTime constructor (RFC 5322, ISO 8601, Unix timestamp with leading "@", natural-language strings, etc.)
Dates in the future are not permitted for email headers; if the parsed date is later than "now" the method falls back to the current time via self::rfcDate().
An empty value, a non-string/non-DateTime argument, or any value that cannot be parsed will likewise fall back to self::rfcDate().
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 1 of the 5 tracked releases, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$dateDateTime|DateTimeImmutable|string- The date to normalise
Return value
string- An RFC 5322-formatted date string
Performance profile
How much work a call to PHPMailer::sanitiseDate() 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
- 15–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 42.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost PHPMailer::sanitiseDate() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!($date instanceof) | 15–17 | date_default_timezone_get(), date_default_timezone_set(), ::rfcDate() |
| always | 21–28 | date_default_timezone_get(), date_default_timezone_set(), ->getTimestamp(), time(), ::rfcDate() |
| always | 23–30 | date_default_timezone_get(), date_default_timezone_set(), ->getTimestamp(), time(), ->format() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 42 instructions, 15–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 · 2
- DateTime::__construct()
- \PHPMailer\PHPMailer\PHPMailer::rfcDate()
Source code
private static function sanitiseDate($date) { try { //Ensure the default timezone is set properly date_default_timezone_set(@date_default_timezone_get()); if ($date instanceof \DateTimeInterface) { $dt = $date; } elseif (is_string($date) && $date !== '') { $dt = new \DateTime($date); } else { //Empty string, null, or any unsupported type return self::rfcDate(); } //Reject future dates — they are invalid for outgoing message headers if ($dt->getTimestamp() > time()) { return self::rfcDate(); } return $dt->format(self::RFC822_DATE_FORMAT); } catch (\Exception $e) { return self::rfcDate(); } }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.