render_block_core_archives( 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 post content with archives added.

Performance profile

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

33–87

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

Plugin surface

2 hooks

Third-party callbacks on 'widget_archives_dropdown_args', 'widget_archives_args' 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
• cacheobject cachewp_cache_get_last_changed()one call below render_block_core_archives()
• optionoption read or writeget_option()one call below render_block_core_archives()

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

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

Hooks and filters fired · 2

2 hooks fire while render_block_core_archives() runs, in this order:

1. 1
   apply_filters( widget_archives_dropdown_args )filterline 33 (+14 into the body)

   Filters the arguments for the Archives widget drop-down.

2. 2
   apply_filters( widget_archives_args )filterline 83 (+64 into the body)

   Filters the arguments for the Archives widget.

Uses · 8

• wp_unique_id()Gets unique ID.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_archives()Displays archive links based on type and format.
• 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.
• esc_html()Escaping for HTML blocks.
• esc_attr()Escaping for HTML attributes.
• block_core_archives_build_dropdown_script()Generates the inline script for an archives dropdown field.

Source code

View on Trac ↗View on GitHub ↗

19function render_block_core_archives( $attributes ) {20	$show_post_count = ! empty( $attributes['showPostCounts'] );21	$type            = $attributes['type'] ?? 'monthly';22 23	$class = 'wp-block-archives-list';24 25	if ( ! empty( $attributes['displayAsDropdown'] ) ) {26 27		$class = 'wp-block-archives-dropdown';28 29		$dropdown_id = wp_unique_id( 'wp-block-archives-' );30		$title       = __( 'Archives' );31 32		/** This filter is documented in wp-includes/widgets/class-wp-widget-archives.php */33		$dropdown_args = apply_filters(34			'widget_archives_dropdown_args',35			array(36				'type'            => $type,37				'format'          => 'option',38				'show_post_count' => $show_post_count,39			)40		);41 42		$dropdown_args['echo'] = 0;43 44		$archives = wp_get_archives( $dropdown_args );45 46		$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $class ) );47 48		switch ( $dropdown_args['type'] ) {49			case 'yearly':50				$label = __( 'Select Year' );51				break;52			case 'monthly':53				$label = __( 'Select Month' );54				break;55			case 'daily':56				$label = __( 'Select Day' );57				break;58			case 'weekly':59				$label = __( 'Select Week' );60				break;61			default:62				$label = __( 'Select Post' );63				break;64		}65 66		$show_label = empty( $attributes['showLabel'] ) ? ' screen-reader-text' : '';67 68		$block_content = '<label for="' . $dropdown_id . '" class="wp-block-archives__label' . $show_label . '">' . esc_html( $title ) . '</label>69		<select id="' . esc_attr( $dropdown_id ) . '" name="archive-dropdown">70		<option value="">' . esc_html( $label ) . '</option>' . $archives . '</select>';71 72		// Inject the dropdown script immediately after the select dropdown.73		$block_content .= block_core_archives_build_dropdown_script( $dropdown_id );74 75		return sprintf(76			'<div %1$s>%2$s</div>',77			$wrapper_attributes,78			$block_content79		);80	}81 82	/** This filter is documented in wp-includes/widgets/class-wp-widget-archives.php */83	$archives_args = apply_filters(84		'widget_archives_args',85		array(86			'type'            => $type,87			'show_post_count' => $show_post_count,88		)89	);90 91	$archives_args['echo'] = 0;92 93	$archives = wp_get_archives( $archives_args );94 95	$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $class ) );96 97	if ( empty( $archives ) ) {98		return sprintf(

Changelog

Introduced in 5.0.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/archives.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.