get_calendar( bool $initial = true, bool $display = true ): 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

$initialbooloptional

Whether to use initial calendar names. Default true.Default: true

$displaybooloptional

Whether to display the calendar output. Default true.Default: true

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

200–268

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

Plugin surface

1 hook

Third-party callbacks on '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

• cacheobject cachewp_cache_get()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• sqldatabase query->get_row()called directly
• serializeserialisationmaybe_unserialize()one call below get_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 · 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 )filterline 2256 (+8 into the body)

   Filters the HTML calendar output.

2. 2
   apply_filters( get_calendar )filterline 2463 (+215 into the body)

   Filters the HTML calendar output.

3. 3
   apply_filters( get_calendar )filterline 2467 (+219 into the body)

   Filters the HTML calendar output.

Uses · 12

• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_cache_set()Saves the data to the cache.
• get_option()Retrieves an option value based on an option name.
• zeroise()Add leading zeros when necessary.
• current_time()Retrieves the current time based on specified type.
• _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.
• __()Retrieves the translation of $text.
• get_day_link()Retrieves the permalink for the day archives with year and month.
• get_month_link()Retrieves the permalink for the month archives with year.

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 ↗

2248function get_calendar( $initial = true, $display = true ) {2249	global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;2250 2251	$key   = md5( $m . $monthnum . $year );2252	$cache = wp_cache_get( 'get_calendar', 'calendar' );2253 2254	if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) {2255		/** This filter is documented in wp-includes/general-template.php */2256		$output = apply_filters( 'get_calendar', $cache[ $key ] );2257 2258		if ( $display ) {2259			echo $output;2260			return;2261		}2262 2263		return $output;2264	}2265 2266	if ( ! is_array( $cache ) ) {2267		$cache = array();2268	}2269 2270	// Quick check. If we have no posts at all, abort!2271	if ( ! $posts ) {2272		$gotsome = $wpdb->get_var( "SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1" );2273		if ( ! $gotsome ) {2274			$cache[ $key ] = '';2275			wp_cache_set( 'get_calendar', $cache, 'calendar' );2276			return;2277		}2278	}2279 2280	if ( isset( $_GET['w'] ) ) {2281		$w = (int) $_GET['w'];2282	}2283	// week_begins = 0 stands for Sunday.2284	$week_begins = (int) get_option( 'start_of_week' );2285 2286	// Let's figure out when we are.2287	if ( ! empty( $monthnum ) && ! empty( $year ) ) {2288		$thismonth = zeroise( (int) $monthnum, 2 );2289		$thisyear  = (int) $year;2290	} elseif ( ! empty( $w ) ) {2291		// We need to get the month from MySQL.2292		$thisyear = (int) substr( $m, 0, 4 );2293		// It seems MySQL's weeks disagree with PHP's.2294		$d         = ( ( $w - 1 ) * 7 ) + 6;2295		$thismonth = $wpdb->get_var( "SELECT DATE_FORMAT((DATE_ADD('{$thisyear}0101', INTERVAL $d DAY) ), '%m')" );2296	} elseif ( ! empty( $m ) ) {2297		$thisyear = (int) substr( $m, 0, 4 );2298		if ( strlen( $m ) < 6 ) {2299			$thismonth = '01';2300		} else {2301			$thismonth = zeroise( (int) substr( $m, 4, 2 ), 2 );2302		}2303	} else {2304		$thisyear  = current_time( 'Y' );2305		$thismonth = current_time( 'm' );2306	}2307 2308	$unixmonth = mktime( 0, 0, 0, $thismonth, 1, $thisyear );2309	$last_day  = gmdate( 't', $unixmonth );2310 2311	// Get the next and previous month and year with at least one post.2312	$previous = $wpdb->get_row(2313		"SELECT MONTH(post_date) AS month, YEAR(post_date) AS year2314		FROM $wpdb->posts2315		WHERE post_date < '$thisyear-$thismonth-01'2316		AND post_type = 'post' AND post_status = 'publish'2317		ORDER BY post_date DESC2318		LIMIT 1"2319	);2320	$next     = $wpdb->get_row(2321		"SELECT MONTH(post_date) AS month, YEAR(post_date) AS year2322		FROM $wpdb->posts2323		WHERE post_date > '$thisyear-$thismonth-{$last_day} 23:59:59'2324		AND post_type = 'post' AND post_status = 'publish'2325		ORDER BY post_date ASC2326		LIMIT 1"2327	);

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 6.7.7 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.