wp_theme_auto_update_setting_template(): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

string

The template for displaying the auto-update setting link.

Performance profile

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

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

36

Executed per call on PHP 8.5. The body compiles to 36.

Plugin surface

1 hook

Third-party callbacks on 'theme_auto_update_setting_template' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

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 · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while wp_theme_auto_update_setting_template() runs, in this order:

1. 1
   apply_filters( theme_auto_update_setting_template )filterline 826 (+46 into the body)

   Filters the JavaScript template used to display the auto-update setting for a theme (in the overlay).

Uses · 4

• wp_get_admin_notice()Creates and returns the markup for an admin notice.
• __()Retrieves the translation of $text.
• wp_get_auto_update_message()Determines the appropriate auto-update message to be displayed.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

780function wp_theme_auto_update_setting_template() {781	$notice   = wp_get_admin_notice(782		'',783		array(784			'type'               => 'error',785			'additional_classes' => array( 'notice-alt', 'inline', 'hidden' ),786		)787	);788	$template = '789		<div class="theme-autoupdate">790			<# if ( data.autoupdate.supported ) { #>791				<# if ( data.autoupdate.forced === false ) { #>792					' . __( 'Auto-updates disabled' ) . '793				<# } else if ( data.autoupdate.forced ) { #>794					' . __( 'Auto-updates enabled' ) . '795				<# } else if ( data.autoupdate.enabled ) { #>796					<button type="button" class="toggle-auto-update button-link" data-slug="{{ data.id }}" data-wp-action="disable">797						<span class="dashicons dashicons-update spin hidden" aria-hidden="true"></span><span class="label">' . __( 'Disable auto-updates' ) . '</span>798					</button>799				<# } else { #>800					<button type="button" class="toggle-auto-update button-link" data-slug="{{ data.id }}" data-wp-action="enable">801						<span class="dashicons dashicons-update spin hidden" aria-hidden="true"></span><span class="label">' . __( 'Enable auto-updates' ) . '</span>802					</button>803				<# } #>804			<# } #>805			<# if ( data.hasUpdate ) { #>806				<# if ( data.autoupdate.supported && data.autoupdate.enabled ) { #>807					<span class="auto-update-time">808				<# } else { #>809					<span class="auto-update-time hidden">810				<# } #>811				<br />' . wp_get_auto_update_message() . '</span>812			<# } #>813			' . $notice . '814		</div>815	';816 817	/**818	 * Filters the JavaScript template used to display the auto-update setting for a theme (in the overlay).819	 *820	 * See {@see wp_prepare_themes_for_js()} for the properties of the `data` object.821	 *822	 * @since 5.5.0823	 *824	 * @param string $template The template for displaying the auto-update setting link.825	 */826	return apply_filters( 'theme_auto_update_setting_template', $template );827}

Changelog

Introduced in 5.5.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/themes.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.