DateInterval::format
PHP 5 >= 5.3.0, PHP 7, PHP 8
DateInterval::format - Formats the interval
Manual
DateInterval::format(
string$format ): public string
Formats the interval.
Parameters
- format
-
The following characters are recognized in the format parameter string. Each format character must be prefixed by a percent sign (%).
format character Description Example values % Literal % % Y Years, numeric, at least 2 digits with leading 0 01, 03 y Years, numeric 1, 3 M Months, numeric, at least 2 digits with leading 0 01, 03, 12 m Months, numeric 1, 3, 12 D Days, numeric, at least 2 digits with leading 0 01, 03, 31 d Days, numeric 1, 3, 31 a Total number of days as a result of a DateTime::diff or (unknown) otherwise 4, 18, 8123 H Hours, numeric, at least 2 digits with leading 0 01, 03, 23 h Hours, numeric 1, 3, 23 I Minutes, numeric, at least 2 digits with leading 0 01, 03, 59 i Minutes, numeric 1, 3, 59 S Seconds, numeric, at least 2 digits with leading 0 01, 03, 57 s Seconds, numeric 1, 3, 57 F Microseconds, numeric, at least 6 digits with leading 0 007701, 052738, 428291 f Microseconds, numeric 7701, 52738, 428291 R Sign "-" when negative, "+" when positive -, + r Sign "-" when negative, empty when positive -,
Return Values
Returns the formatted interval.
Notes
Note:
The DateInterval::format method does not recalculate carry over points in time strings nor in date segments. This is expected because it is not possible to overflow values like "32 days" which could be interpreted as anything from "1 month and 4 days" to "1 month and 1 day".
Changelog
| Version | Description |
| 7.1.0 | The F and f format characters were added. |