render_block_core_calendar( array $attributes ): string

Compatibility

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

Parameters

$attributesarray

The block attributes.

Return value

string

Returns the block content.

Performance profile

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

10–115

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

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 render_block_core_calendar()
• cacheobject cachewp_cache_get()one call below render_block_core_calendar()
• serializeserialisationmaybe_unserialize()one call below render_block_core_calendar()

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 · 8 distinct outcomes

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

Uses · 9

• block_core_calendar_has_published_posts()Returns whether or not there are any published posts.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_style_engine_get_styles()Global public interface method to generate styles from a single style object, e.g. the value of a block's attributes.style object or the top level styles in theme.json.
• esc_attr()Escaping for HTML attributes.
• get_calendar()Displays calendar with days that have posts as links.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.

Source code

View on Trac ↗View on GitHub ↗

20function render_block_core_calendar( $attributes ) {21	global $monthnum, $year;22 23	// Calendar shouldn't be rendered24	// when there are no published posts on the site.25	if ( ! block_core_calendar_has_published_posts() ) {26		if ( is_user_logged_in() ) {27			return '<div>' . __( 'The calendar block is hidden because there are no published posts.' ) . '</div>';28		}29		return '';30	}31 32	$previous_monthnum = $monthnum;33	$previous_year     = $year;34 35	if ( isset( $attributes['month'] ) && isset( $attributes['year'] ) ) {36		$permalink_structure = get_option( 'permalink_structure' );37		if (38			str_contains( $permalink_structure, '%monthnum%' ) &&39			str_contains( $permalink_structure, '%year%' )40		) {41			$monthnum = $attributes['month'];42			$year     = $attributes['year'];43		}44	}45 46	$color_block_styles = array();47 48	// Text color.49	$preset_text_color          = array_key_exists( 'textColor', $attributes ) ? "var:preset|color|{$attributes['textColor']}" : null;50	$custom_text_color          = $attributes['style']['color']['text'] ?? null;51	$color_block_styles['text'] = $preset_text_color ? $preset_text_color : $custom_text_color;52 53	// Background Color.54	$preset_background_color          = array_key_exists( 'backgroundColor', $attributes ) ? "var:preset|color|{$attributes['backgroundColor']}" : null;55	$custom_background_color          = $attributes['style']['color']['background'] ?? null;56	$color_block_styles['background'] = $preset_background_color ? $preset_background_color : $custom_background_color;57 58	// Generate color styles and classes.59	$styles        = wp_style_engine_get_styles( array( 'color' => $color_block_styles ), array( 'convert_vars_to_classnames' => true ) );60	$inline_styles = empty( $styles['css'] ) ? '' : sprintf( ' style="%s"', esc_attr( $styles['css'] ) );61	$classnames    = empty( $styles['classnames'] ) ? '' : ' ' . esc_attr( $styles['classnames'] );62	if ( isset( $attributes['style']['elements']['link']['color']['text'] ) ) {63		$classnames .= ' has-link-color';64	}65	// Apply color classes and styles to the calendar.66	$calendar = str_replace( '<table', '<table' . $inline_styles, get_calendar( true, false ) );67	$calendar = str_replace( 'class="wp-calendar-table', 'class="wp-calendar-table' . $classnames, $calendar );68 69	$wrapper_attributes = get_block_wrapper_attributes();70	$output             = sprintf(71		'<div %1$s>%2$s</div>',72		$wrapper_attributes,73		$calendar74	);75 76	$monthnum = $previous_monthnum;77	$year     = $previous_year;78 79	return $output;80}

Changelog

Introduced in 5.2.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/blocks/calendar.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.