mysql2date( string $format, string $date, bool $translate = true ): string|int|false
- Since
- 0.71
- Source
wp-includes/functions.php:35
Description
$formatshould be a PHP date format string.- 'U' and 'G' formats will return an integer sum of timestamp with timezone offset.
$dateis expected to be local time in MySQL format (Y-m-d H:i:s).
Historically UTC time could be passed to the function to produce Unix timestamp.
If $translate is true then the given date and format string will be passed to wp_date() for translation.
Compatibility
- WordPress
- since 0.71
- 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
$formatstring- Format of the date to return.
$datestring- Date string to convert.
$translatebooloptional- Whether the return date should be translated. Default true.Default:
true
Return value
string|int|false- Integer if
$formatis 'U' or 'G', string otherwise.
False on failure.
Performance profile
How much work a call to mysql2date() 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
- 6–28
- Plugin surface
- None
- Called by
- 31
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 40.
Nothing here hands control to plugin code.
31 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below mysql2date()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost mysql2date() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($date) | 6 | none |
!empty($date) && $datetime === false | 16 | wp_timezone(), date_create() |
!empty($date) && $datetime !== false | 23–25 | wp_timezone(), date_create(), ->getTimestamp(), ->getOffset() |
!empty($date) && $datetime !== false && $format !== "G" && $format !== "U" | 24 | wp_timezone(), date_create(), ->format() |
!empty($date) && $datetime !== false && $format !== "G" && $format !== "U" | 28 | wp_timezone(), date_create(), ->getTimestamp(), wp_date() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 40 instructions, 6–28 executed per call, 5 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
- wp_timezone()Retrieves the timezone of the site as a `DateTimeZone` object.
- wp_date()Retrieves the date, in localized format.
Used by · 31
- TwentyTwenty_Walker_Page::start_el()Outputs the beginning of the current element in the tree.
- WP::send_headers()Sends additional HTTP headers for caching, content type, etc.
- WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.
- WP_MS_Sites_List_Table::column_lastupdated()Handles the lastupdated column output.
- WP_MS_Sites_List_Table::column_registered()Handles the registered column output.
- WP_MS_Users_List_Table::column_registered()Handles the registered date column output.
- Walker_Page::start_el()Outputs the beginning of the current element in the tree.
- _WP_Editors::wp_link_query()Performs post queries for internal linking.
- export_wp()Generates the WXR export file for download.
- get_adjacent_post_link()Retrieves the adjacent post link.
- get_adjacent_post_rel_link()Retrieves the adjacent post relational link.
- get_boundary_post_rel_link()Get boundary post relational link.
Show all 31
- get_comment_date()Retrieves the comment date of the current comment.
- get_comment_time()Retrieves the comment time of the current comment.
- get_inline_data()Adds hidden fields with the data for use in the inline editor for posts and pages.
- get_media_item()Retrieves HTML form for modifying the image attachment.
- get_parent_post_rel_link()Get parent post relational link.
- mysql_to_rfc3339()Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601 (Y-m-d\TH:i:s).
- the_date_xml()Outputs the date in iso8601 format for xml files.
- touch_time()Prints out HTML form date elements for editing post or comment publish date.
- upgrade_210()Execute changes made in WordPress 2.1.
- wp_ajax_find_posts()Handles querying posts for the Find Posts modal via AJAX.
- wp_ajax_wp_fullscreen_save_post()Handles saving posts from the fullscreen editor via AJAX.
- wp_check_comment_flood()Checks whether comment flooding is occurring.
- wp_get_archives()Displays archive links based on type and format.
- wp_prepare_attachment_for_js()Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
- wp_xmlrpc_server::_convert_date()Converts a WordPress date string to an IXR_Date object.
- wp_xmlrpc_server::_convert_date_gmt()Converts a WordPress GMT date string to an IXR_Date object.
- wp_xmlrpc_server::wp_editPost()Edits a post for any registered post type.
- wpmu_validate_blog_signup()Processes new site registrations.
- wpmu_validate_user_signup()Sanitizes and validates data required for a user sign-up.
Source code
function mysql2date( $format, $date, $translate = true ) { if ( empty( $date ) ) { return false; } $timezone = wp_timezone(); $datetime = date_create( $date, $timezone ); if ( false === $datetime ) { return false; } // Returns a sum of timestamp with timezone offset. Ideally should never be used. if ( 'G' === $format || 'U' === $format ) { return $datetime->getTimestamp() + $datetime->getOffset(); } if ( $translate ) { return wp_date( $format, $datetime->getTimestamp(), $timezone ); } return $datetime->format( $format );}Changelog
Introduced in 0.71. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/functions.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.