Date
Date module for WordPress.
Installation
Install the module
npm install @wordpress/date --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.
API
# date
Formats a date (like date()
in PHP).
Related
Parameters
- dateFormat
string
: PHP-style formatting string. See php.net/date. - dateValue
Moment | Date | string | undefined
: Date object or string, parsable by moment.js. - timezone
string | undefined
: Timezone to output result in or a UTC offset. Defaults to timezone from site.
Returns
string
: Formatted date in English.
# dateI18n
Formats a date (like wp_date()
in PHP), translating it into site's locale.
Backward Compatibility Notice: if timezone
is set to true
, the function
behaves like gmdateI18n
.
Related
Parameters
- dateFormat
string
: PHP-style formatting string. See php.net/date. - dateValue
Moment | Date | string | undefined
: Date object or string, parsable by moment.js. - timezone
string | boolean | undefined
: Timezone to output result in or a UTC offset. Defaults to timezone from site. Notice: boolean
is effectively deprecated, but still supported for backward compatibility reasons.
Returns
# format
Formats a date. Does not alter the date's timezone.
Parameters
- dateFormat
string
: PHP-style formatting string. See php.net/date. - dateValue
Moment | Date | string | undefined
: Date object or string, parsable by moment.js.
Returns
# getDate
Create and return a JavaScript Date Object from a date string in the WP timezone.
Parameters
- dateString
string?
: Date formatted in the WP timezone.
Returns
# gmdate
Formats a date (like date()
in PHP), in the UTC timezone.
Parameters
- dateFormat
string
: PHP-style formatting string. See php.net/date. - dateValue
Moment | Date | string | undefined
: Date object or string, parsable by moment.js.
Returns
string
: Formatted date in English.
# gmdateI18n
Formats a date (like wp_date()
in PHP), translating it into site's locale
and using the UTC timezone.
Parameters
- dateFormat
string
: PHP-style formatting string. See php.net/date. - dateValue
Moment | Date | string | undefined
: Date object or string, parsable by moment.js.
Returns
# isInTheFuture
Check whether a date is considered in the future according to the WordPress settings.
Parameters
- dateValue
string
: Date String or Date object in the Defined WP Timezone.
Returns
boolean
: Is in the future.
# setSettings
Adds a locale to moment, using the format supplied by wp_localize_script()
.
Parameters
- dateSettings
DateSettings
: Settings, including locale data.