wppaste
WordPress

wp_localize_jquery_ui_datepicker()

Since
4.6.0
Source
wp-includes/script-loader.php:1994
Localizes the jQuery UI datepicker.

Compatibility

WordPress
since 4.6.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.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

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

Instructions
7–78

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

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

  • optionoption read or writeget_option()called directly
  • hookthird-party callbacksapply_filters()one call below wp_localize_jquery_ui_datepicker()
  • cacheobject cachewp_cache_get()one call below wp_localize_jquery_ui_datepicker()
  • serializeserialisationmaybe_unserialize()one call below wp_localize_jquery_ui_datepicker()

Further down the call graph this can also reach 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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!wp_script_is()7wp_script_is()
wp_script_is()78wp_script_is(), get_option(), __(), __(), array_values(), array_values(), _x(), _x(), array_values(), array_values(), array_values(), get_option(), absint(), ->is_rtl(), closeText(), wp_add_inline_script()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev797–781
8.5797–781
8.4797–7814 fewer instructions than PHP 8.3
8.3837–821
8.2837–821
8.1837–821
7.4837–821

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 · 7

  • wp_script_is()Determines whether a script has been added to the queue.
  • get_option()Retrieves an option value based on an option name.
  • wp_json_encode()Encodes a variable into JSON, with some confidence checks.
  • __()Retrieves the translation of $text.
  • _x()Retrieves translated string with gettext context.
  • absint()Converts a value to non-negative integer.
  • wp_add_inline_script()Adds extra code to a registered script.

Source code

View on Trac View on GitHub 

function wp_localize_jquery_ui_datepicker() {	global $wp_locale; 	if ( ! wp_script_is( 'jquery-ui-datepicker', 'enqueued' ) ) {		return;	} 	// Convert the PHP date format into jQuery UI's format.	$datepicker_date_format = str_replace(		array(			'd',			'j',			'l',			'z', // Day.			'F',			'M',			'n',			'm', // Month.			'Y',			'y', // Year.		),		array(			'dd',			'd',			'DD',			'o',			'MM',			'M',			'm',			'mm',			'yy',			'y',		),		get_option( 'date_format' )	); 	$datepicker_defaults = wp_json_encode(		array(			'closeText'       => __( 'Close' ),			'currentText'     => __( 'Today' ),			'monthNames'      => array_values( $wp_locale->month ),			'monthNamesShort' => array_values( $wp_locale->month_abbrev ),			'nextText'        => _x( 'Next', 'datepicker: navigate to next month' ),			'prevText'        => _x( 'Previous', 'datepicker: navigate to previous month' ),			'dayNames'        => array_values( $wp_locale->weekday ),			'dayNamesShort'   => array_values( $wp_locale->weekday_abbrev ),			'dayNamesMin'     => array_values( $wp_locale->weekday_initial ),			'dateFormat'      => $datepicker_date_format,			'firstDay'        => absint( get_option( 'start_of_week' ) ),			'isRTL'           => $wp_locale->is_rtl(),		),		JSON_HEX_TAG | JSON_UNESCAPED_SLASHES	); 	wp_add_inline_script( 'jquery-ui-datepicker', "jQuery(function(jQuery){jQuery.datepicker.setDefaults({$datepicker_defaults});});" );}

Changelog

Introduced in 4.6.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 7.1.0 tag, from src/wp-includes/script-loader.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.