WP_Community_Events::format_event_data_time( array $response_body ): array

Description

Compatibility

Deprecated in WordPress 5.5.2. No longer used in core.

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

Parameters

$response_bodyarray

The response which contains the events.

Return value

array

The response with dates and times formatted.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

8–12

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

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 callbacksdo_action()one call below WP_Community_Events::format_event_data_time()
• cacheobject cachewp_cache_get()one call below WP_Community_Events::format_event_data_time()
• serializeserialisationmaybe_unserialize()one call below WP_Community_Events::format_event_data_time()

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

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

Uses · 6

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• date_i18n()Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• _x()Retrieves translated string with gettext context.
• wp_maybe_decline_date()Determines if the date should be declined.

Source code

View on Trac ↗View on GitHub ↗

383	protected function format_event_data_time( $response_body ) {384		_deprecated_function( __METHOD__, '5.5.2' );385 386		if ( isset( $response_body['events'] ) ) {387			foreach ( $response_body['events'] as $key => $event ) {388				$timestamp = strtotime( $event['date'] );389 390				/*391				 * The `date_format` option is not used because it's important392				 * in this context to keep the day of the week in the formatted date,393				 * so that users can tell at a glance if the event is on a day they394				 * are available, without having to open the link.395				 */396				/* translators: Date format for upcoming events on the dashboard. Include the day of the week. See https://www.php.net/manual/datetime.format.php */397				$formatted_date = date_i18n( __( 'l, M j, Y' ), $timestamp );398				$formatted_time = date_i18n( get_option( 'time_format' ), $timestamp );399 400				if ( isset( $event['end_date'] ) ) {401					$end_timestamp      = strtotime( $event['end_date'] );402					$formatted_end_date = date_i18n( __( 'l, M j, Y' ), $end_timestamp );403 404					if ( 'meetup' !== $event['type'] && $formatted_end_date !== $formatted_date ) {405						/* translators: Upcoming events month format. See https://www.php.net/manual/datetime.format.php */406						$start_month = date_i18n( _x( 'F', 'upcoming events month format' ), $timestamp );407						$end_month   = date_i18n( _x( 'F', 'upcoming events month format' ), $end_timestamp );408 409						if ( $start_month === $end_month ) {410							$formatted_date = sprintf(411								/* translators: Date string for upcoming events. 1: Month, 2: Starting day, 3: Ending day, 4: Year. */412								__( '%1$s %2$d–%3$d, %4$d' ),413								$start_month,414								/* translators: Upcoming events day format. See https://www.php.net/manual/datetime.format.php */415								date_i18n( _x( 'j', 'upcoming events day format' ), $timestamp ),416								date_i18n( _x( 'j', 'upcoming events day format' ), $end_timestamp ),417								/* translators: Upcoming events year format. See https://www.php.net/manual/datetime.format.php */418								date_i18n( _x( 'Y', 'upcoming events year format' ), $timestamp )419							);420						} else {421							$formatted_date = sprintf(422								/* translators: Date string for upcoming events. 1: Starting month, 2: Starting day, 3: Ending month, 4: Ending day, 5: Year. */423								__( '%1$s %2$d – %3$s %4$d, %5$d' ),424								$start_month,425								date_i18n( _x( 'j', 'upcoming events day format' ), $timestamp ),426								$end_month,427								date_i18n( _x( 'j', 'upcoming events day format' ), $end_timestamp ),428								date_i18n( _x( 'Y', 'upcoming events year format' ), $timestamp )429							);430						}431 432						$formatted_date = wp_maybe_decline_date( $formatted_date, 'F j, Y' );433					}434				}435 436				$response_body['events'][ $key ]['formatted_date'] = $formatted_date;437				$response_body['events'][ $key ]['formatted_time'] = $formatted_time;438			}439		}440 441		return $response_body;442	}

Changelog

Introduced in 4.8.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/includes/class-wp-community-events.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.