wppaste
WordPress

heartbeat_autosave( array $response, array $data ): array

Since
3.9.0
Source
wp-admin/includes/misc.php:1350
Performs autosave with heartbeat.

Compatibility

WordPress
since 3.9.0
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

$responsearray
The Heartbeat response.
$dataarray
The $_POST data sent.

Return value

array
The Heartbeat response.

Performance profile

How much work a call to heartbeat_autosave() 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
Heavy

Reaches the database via get_post().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
5–35

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

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 it touches

  • querycontent queryget_post()one call below heartbeat_autosave()
  • hookthird-party callbacksdo_action()one call below heartbeat_autosave()

Further down the call graph this can also reach option, cache, serialize 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 · 4 distinct outcomes

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

WhenInstructionsCalls it makes
empty($data)5none
!empty($data) && is_wp_error()21wp_autosave(), is_wp_error(), ->get_error_message()
!empty($data) && !is_wp_error() && empty($saved)24wp_autosave(), is_wp_error(), __()
!empty($data) && !is_wp_error() && !empty($saved)35wp_autosave(), is_wp_error(), __(), __(), date_i18n(), sprintf()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 50 instructions, 5–35 executed per call, 3 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 · 4

  • wp_autosave()Saves a post submitted with XHR.
  • is_wp_error()Checks whether the given variable is a WordPress Error.
  • __()Retrieves the translation of $text.
  • date_i18n()Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.

Source code

function heartbeat_autosave( $response, $data ) {	if ( ! empty( $data['wp_autosave'] ) ) {		$saved = wp_autosave( $data['wp_autosave'] ); 		if ( is_wp_error( $saved ) ) {			$response['wp_autosave'] = array(				'success' => false,				'message' => $saved->get_error_message(),			);		} elseif ( empty( $saved ) ) {			$response['wp_autosave'] = array(				'success' => false,				'message' => __( 'Error while saving.' ),			);		} else {			/* translators: Draft saved date format, see https://www.php.net/manual/datetime.format.php */			$draft_saved_date_format = __( 'g:i:s a' );			$response['wp_autosave'] = array(				'success' => true,				/* translators: %s: Date and time. */				'message' => sprintf( __( 'Draft saved at %s.' ), date_i18n( $draft_saved_date_format ) ),			);		}	} 	return $response;}

Changelog

Introduced in 3.9.0. 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 6.9.7 tag, from src/wp-admin/includes/misc.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.