wp_heartbeat_settings( array $settings )

Default settings for heartbeat

Description

Outputs the nonce used in the heartbeat XHR

Parameters

$settings

(array) (Required)

Return

(array) Heartbeat settings.

Source

File: wp-includes/general-template.php 

function wp_heartbeat_settings( $settings ) {
	if ( ! is_admin() ) {
		$settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' );
	}

	if ( is_user_logged_in() ) {
		$settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' );
	}

	return $settings;
}

Uses

Uses Description
wp-includes/pluggable.php: wp_create_nonce()

Creates a cryptographic token tied to a specific action, user, user session, and window of time.
wp-includes/pluggable.php: is_user_logged_in()

Determines whether the current visitor is a logged in user.
wp-includes/load.php: is_admin()

Determines whether the current request is for an administrative interface page.
wp-includes/link-template.php: admin_url()

Retrieves the URL to the admin area for the current site.

Changelog

Version Description
3.6.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_heartbeat_settings