get_calendar( array $args = array() ): void|string

Description

Compatibility

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

Parameters

$argsarrayoptional

Arguments for the get_calendar function.Default: array()

• $initialbooldefault: true

  Whether to use initial calendar names.

• $displaybooldefault: true

  Whether to display the calendar output.

• $post_typestringdefault: 'post'

  Optional. Post type.

Return value

void|string

Void if $display argument is true, calendar HTML if $display is false.

Performance profile

How much work a call to get_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

Heavy

Reaches the database via ->get_row().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

256–323

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

Plugin surface

2 hooks

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

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()called directly
• optionoption read or writeget_option()called directly
• serializeserialisationserialize()called directly
• sqldatabase query->get_row()called directly

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while get_calendar() runs, in this order:

1. 1
   apply_filters( get_calendar_args )filterline 2515 (+38 into the body)

   Filter the `get_calendar` function arguments before they are used.

2. 2
   apply_filters( get_calendar )filterline 2554 (+77 into the body)

   Filters the HTML calendar output.

3. 3
   apply_filters( get_calendar )filterline 2809 (+332 into the body)

   Filters the HTML calendar output.

Uses · 15

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_parse_args()Merges user defined arguments into defaults array.
• post_type_exists()Determines whether a post type is registered.
• wp_recursive_ksort()Sorts the keys of an array alphabetically.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• wp_cache_set()Saves the data to the cache.
• get_option()Retrieves an option value based on an option name.
• current_time()Retrieves the current time based on specified type.
• zeroise()Add leading zeros when necessary.
• _x()Retrieves translated string with gettext context.
• esc_attr()Escaping for HTML attributes.
• calendar_week_mod()Gets number of days since the start of the week.

Used by · 2

• WP_Widget_Calendar::widget()Outputs the content for the current Calendar widget instance.
• render_block_core_calendar()Renders the `core/calendar` block on server.

Source code

View on Trac ↗View on GitHub ↗

2477function get_calendar( $args = array() ) {2478	global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;2479 2480	$defaults = array(2481		'initial'   => true,2482		'display'   => true,2483		'post_type' => 'post',2484	);2485 2486	$original_args = func_get_args();2487	$args          = array();2488 2489	if ( ! empty( $original_args ) ) {2490		if ( ! is_array( $original_args[0] ) ) {2491			if ( isset( $original_args[0] ) && is_bool( $original_args[0] ) ) {2492				$defaults['initial'] = $original_args[0];2493			}2494			if ( isset( $original_args[1] ) && is_bool( $original_args[1] ) ) {2495				$defaults['display'] = $original_args[1];2496			}2497		} else {2498			$args = $original_args[0];2499		}2500	}2501 2502	/**2503	 * Filter the `get_calendar` function arguments before they are used.2504	 *2505	 * @since 6.8.02506	 *2507	 * @param array $args {2508	 *     Optional. Arguments for the `get_calendar` function.2509	 *2510	 *     @type bool   $initial   Whether to use initial calendar names. Default true.2511	 *     @type bool   $display   Whether to display the calendar output. Default true.2512	 *     @type string $post_type Optional. Post type. Default 'post'.2513	 * }2514	 */2515	$args = apply_filters( 'get_calendar_args', wp_parse_args( $args, $defaults ) );2516 2517	if ( ! post_type_exists( $args['post_type'] ) ) {2518		$args['post_type'] = 'post';2519	}2520 2521	$w = 0;2522	if ( isset( $_GET['w'] ) ) {2523		$w = (int) $_GET['w'];2524	}2525 2526	/*2527	 * Normalize the cache key.2528	 *2529	 * The following ensures the same cache key is used for the same parameter2530	 * and parameter equivalents. This prevents `post_type > post, initial > true`2531	 * from generating a different key from the same values in the reverse order.2532	 *2533	 * `display` is excluded from the cache key as the cache contains the same2534	 * HTML regardless of this function's need to echo or return the output.2535	 *2536	 * The global values contain data generated by the URL query string variables.2537	 */2538	$cache_args = $args;2539	unset( $cache_args['display'] );2540 2541	$cache_args['globals'] = array(2542		'm'        => $m,2543		'monthnum' => $monthnum,2544		'year'     => $year,2545		'week'     => $w,2546	);2547 2548	wp_recursive_ksort( $cache_args );2549	$key   = md5( serialize( $cache_args ) );2550	$cache = wp_cache_get( 'get_calendar', 'calendar' );2551 2552	if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) {2553		/** This filter is documented in wp-includes/general-template.php */2554		$output = apply_filters( 'get_calendar', $cache[ $key ], $args );2555 2556		if ( $args['display'] ) {

Changelog

Introduced in 1.0.0. 3 changes between 6.7.7 and 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/general-template.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.