wppaste
WordPress

get_weekstartend( string $mysqlstring, int|string $start_of_week = '' ): int[]

Since
0.71
Source
wp-includes/functions.php:587
Gets the week start and end from the datetime or date string from MySQL.

Compatibility

WordPress
since 0.71
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$mysqlstringstring
Date or datetime field type from MySQL.
$start_of_weekint|stringoptional
Start of the week as an integer. Default empty string.Default: ''

Return value

int[]
Week start and end dates as Unix timestamps.
  • $startint

    The week start date as a Unix timestamp.
  • $endint

    The week end date as a Unix timestamp.

Performance profile

How much work a call to get_weekstartend() 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
44–50

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

What it touches

  • optionoption read or writeget_option()called directly
  • hookthird-party callbacksapply_filters()one call below get_weekstartend()
  • cacheobject cachewp_cache_get()one call below get_weekstartend()
  • serializeserialisationmaybe_unserialize()one call below get_weekstartend()

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

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

WhenInstructionsCalls it makes
$start_of_week44–45mktime(), gmdate(), compact()
!$start_of_week49–50mktime(), gmdate(), get_option(), compact()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev5044–502
8.55044–502
8.45044–50211 fewer instructions than PHP 8.3
8.36155–612
8.26155–612
8.16155–612
7.46155–612

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

  • get_option()Retrieves an option value based on an option name.

Used by · 1

Source code

function get_weekstartend( $mysqlstring, $start_of_week = '' ) {	// MySQL string year.	$my = substr( $mysqlstring, 0, 4 ); 	// MySQL string month.	$mm = substr( $mysqlstring, 8, 2 ); 	// MySQL string day.	$md = substr( $mysqlstring, 5, 2 ); 	// The timestamp for MySQL string day.	$day = mktime( 0, 0, 0, $md, $mm, $my ); 	// The day of the week from the timestamp.	$weekday = (int) gmdate( 'w', $day ); 	if ( ! is_numeric( $start_of_week ) ) {		$start_of_week = (int) get_option( 'start_of_week' );	} 	if ( $weekday < $start_of_week ) {		$weekday += 7;	} 	// The most recent week start day on or before $day.	$start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week ); 	// $start + 1 week - 1 second.	$end = $start + WEEK_IN_SECONDS - 1; 	return compact( 'start', 'end' );}

Changelog

Introduced in 0.71. 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-includes/functions.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.