datetime
date/time utilities trait - {eac}Doojigger for WordPress
Tags
Table of Contents
- getDateTime() : object
- Get date/time
- getDateTimeLocal() : object
- local date/time
- getDateTimeUTC() : object
- UTC date/time
- getFormattedDateTime() : string
- Get date/time (returning formatted date/time string)
- getTimeZone() : object
- Get date/time timezone
- isDateTimeBetween() : object
- is date/time between range
- isFormattedDateTime() : string
- is a valid date/time (returning formatted date/time string)
- isValidDate() : object
- is a valid date
- isValidDateTime() : object
- is a valid date/time
- isValidTime() : object
- is a valid time
Methods
getDateTime()
Get date/time
public
getDateTime([mixed $datetime = 'now' ][, mixed $modify = null ][, mixed $timezone = null ]) : object
Parameters
- $datetime : mixed = 'now'
- $modify : mixed = null
- $timezone : mixed = null
Return values
object —DateTime object or false on invalid
getDateTimeLocal()
local date/time
public
getDateTimeLocal([mixed $datetime = 'now' ][, mixed $modify = null ]) : object
Parameters
- $datetime : mixed = 'now'
- $modify : mixed = null
Return values
object —DateTime object or false on invalid
getDateTimeUTC()
UTC date/time
public
getDateTimeUTC([mixed $datetime = 'now' ][, mixed $modify = null ]) : object
Parameters
- $datetime : mixed = 'now'
- $modify : mixed = null
Return values
object —DateTime object or false on invalid
getFormattedDateTime()
Get date/time (returning formatted date/time string)
public
getFormattedDateTime([string $datetime = 'now' ][, string $format = 'Y-m-d H:i:s' ][, object $timezone = null ]) : string
Parameters
- $datetime : string = 'now'
-
date/time string in format
- $format : string = 'Y-m-d H:i:s'
-
date/time format
- $timezone : object = null
-
DateTimeZone
Return values
string —DateTime formatted or null on invalid
getTimeZone()
Get date/time timezone
public
getTimeZone([object|string $timezone = null ][, object $datetime = null ]) : object
Parameters
- $timezone : object|string = null
-
- timezone or DateTimeZone or DateTime (default = wp_timezone())
- $datetime : object = null
-
DateTime
Return values
object —DateTimeZone object or false on invalid
isDateTimeBetween()
is date/time between range
public
isDateTimeBetween(mixed $datetime, mixed $datetimeLo, mixed $datetimeHi[, mixed $timezone = null ]) : object
Parameters
- $datetime : mixed
-
date/time
- $datetimeLo : mixed
-
date/time low
- $datetimeHi : mixed
-
date/time high
- $timezone : mixed = null
-
default = wp_timezone()
Return values
object —DateTime object or false on invalid
isFormattedDateTime()
is a valid date/time (returning formatted date/time string)
public
isFormattedDateTime(string $datetime[, string $format = 'Y-m-d H:i:s' ][, object $timezone = null ]) : string
Parameters
- $datetime : string
-
date/time string in format
- $format : string = 'Y-m-d H:i:s'
-
date/time format
- $timezone : object = null
-
DateTimeZone
Return values
string —DateTime formatted or null on invalid
isValidDate()
is a valid date
public
isValidDate(string $date[, string $format = 'Y-m-d' ][, object $timezone = null ]) : object
Parameters
- $date : string
-
date string in format
- $format : string = 'Y-m-d'
-
date format
- $timezone : object = null
-
DateTimeZone
Return values
object —DateTime object or false on invalid
isValidDateTime()
is a valid date/time
public
isValidDateTime(string $datetime[, string $format = 'Y-m-d H:i:s' ][, object $timezone = null ]) : object
Parameters
- $datetime : string
-
date/time string in format
- $format : string = 'Y-m-d H:i:s'
-
date/time format
- $timezone : object = null
-
DateTimeZone
Return values
object —DateTime object or false on invalid
isValidTime()
is a valid time
public
isValidTime(string $time[, string $format = 'H:i:s' ][, object $timezone = null ]) : object
Parameters
- $time : string
-
time string in format
- $format : string = 'H:i:s'
-
time format
- $timezone : object = null
-
DateTimeZone
Return values
object —DateTime object or false on invalid