{"id":134547,"date":"2021-03-09T08:38:23","date_gmt":"2021-03-09T08:38:23","guid":{"rendered":"https:\/\/developer.wordpress.org\/block-editor\/reference-guides\/packages\/packages-date\/"},"modified":"2024-12-03T18:04:12","modified_gmt":"2024-12-03T18:04:12","slug":"packages-date","status":"publish","type":"blocks-handbook","link":"https:\/\/developer.wordpress.org\/block-editor\/reference-guides\/packages\/packages-date\/","title":{"rendered":"@wordpress\/date"},"content":{"rendered":"<p>Date module for WordPress.<\/p>\n<h2>Installation<\/h2>\n<p>Install the module<\/p>\n<pre><code class=\"language-bash\">npm install @wordpress\/date --save\n<\/code><\/pre>\n<p><em>This package assumes that your code will run in an <strong>ES2015+<\/strong> environment. If you&#8217;re using an environment that has limited or no support for such language features and APIs, you should include <a href=\"https:\/\/github.com\/WordPress\/gutenberg\/tree\/HEAD\/packages\/babel-preset-default#polyfill\">the polyfill shipped in <code>@wordpress\/babel-preset-default<\/code><\/a> in your code.<\/em><\/p>\n<h2>API<\/h2>\n<p><!-- START TOKEN(Autogenerated API docs) --><\/p>\n<h3>date<\/h3>\n<p>Formats a date (like <code>date()<\/code> in PHP).<\/p>\n<p><em>Related<\/em><\/p>\n<ul>\n<li><a href=\"https:\/\/en.wikipedia.org\/wiki\/List_of_tz_database_time_zones\">https:\/\/en.wikipedia.org\/wiki\/List_of_tz_database_time_zones<\/a><\/li>\n<li><a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_8601#Time_offsets_from_UTC\">https:\/\/en.wikipedia.org\/wiki\/ISO_8601#Time_offsets_from_UTC<\/a><\/li>\n<\/ul>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateFormat<\/em> <code>string<\/code>: PHP-style formatting string. See php.net\/date.<\/li>\n<li><em>dateValue<\/em> <code>Moment | Date | string | undefined<\/code>: Date object or string, parsable by moment.js.<\/li>\n<li><em>timezone<\/em> <code>string | number | undefined<\/code>: Timezone to output result in or a UTC offset. Defaults to timezone from site.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>string<\/code>: Formatted date in English.<\/li>\n<\/ul>\n<h3>dateI18n<\/h3>\n<p>Formats a date (like <code>wp_date()<\/code> in PHP), translating it into site&#8217;s locale.<\/p>\n<p>Backward Compatibility Notice: if <code>timezone<\/code> is set to <code>true<\/code>, the function behaves like <code>gmdateI18n<\/code>.<\/p>\n<p><em>Related<\/em><\/p>\n<ul>\n<li><a href=\"https:\/\/en.wikipedia.org\/wiki\/List_of_tz_database_time_zones\">https:\/\/en.wikipedia.org\/wiki\/List_of_tz_database_time_zones<\/a><\/li>\n<li><a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_8601#Time_offsets_from_UTC\">https:\/\/en.wikipedia.org\/wiki\/ISO_8601#Time_offsets_from_UTC<\/a><\/li>\n<\/ul>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateFormat<\/em> <code>string<\/code>: PHP-style formatting string. See php.net\/date.<\/li>\n<li><em>dateValue<\/em> <code>Moment | Date | string | undefined<\/code>: Date object or string, parsable by moment.js.<\/li>\n<li><em>timezone<\/em> <code>string | number | boolean | undefined=<\/code>: Timezone to output result in or a UTC offset. Defaults to timezone from site. Notice: <code>boolean<\/code> is effectively deprecated, but still supported for backward compatibility reasons.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>string<\/code>: Formatted date.<\/li>\n<\/ul>\n<h3>format<\/h3>\n<p>Formats a date. Does not alter the date&#8217;s timezone.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateFormat<\/em> <code>string<\/code>: PHP-style formatting string. See php.net\/date.<\/li>\n<li><em>dateValue<\/em> <code>Moment | Date | string | undefined<\/code>: Date object or string, parsable by moment.js.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>string<\/code>: Formatted date.<\/li>\n<\/ul>\n<h3>getDate<\/h3>\n<p>Create and return a JavaScript Date Object from a date string in the WP timezone.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateString<\/em> <code>?string<\/code>: Date formatted in the WP timezone.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>Date<\/code>: Date<\/li>\n<\/ul>\n<h3>getSettings<\/h3>\n<p>Returns the currently defined date settings.<\/p>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>DateSettings<\/code>: Settings, including locale data.<\/li>\n<\/ul>\n<h3>gmdate<\/h3>\n<p>Formats a date (like <code>date()<\/code> in PHP), in the UTC timezone.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateFormat<\/em> <code>string<\/code>: PHP-style formatting string. See php.net\/date.<\/li>\n<li><em>dateValue<\/em> <code>Moment | Date | string | undefined<\/code>: Date object or string, parsable by moment.js.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>string<\/code>: Formatted date in English.<\/li>\n<\/ul>\n<h3>gmdateI18n<\/h3>\n<p>Formats a date (like <code>wp_date()<\/code> in PHP), translating it into site&#8217;s locale and using the UTC timezone.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateFormat<\/em> <code>string<\/code>: PHP-style formatting string. See php.net\/date.<\/li>\n<li><em>dateValue<\/em> <code>Moment | Date | string | undefined<\/code>: Date object or string, parsable by moment.js.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>string<\/code>: Formatted date.<\/li>\n<\/ul>\n<h3>humanTimeDiff<\/h3>\n<p>Returns a human-readable time difference between two dates, like <a href=\"https:\/\/developer.wordpress.org\/reference\/functions\/human_time_diff\/\" rel=\"function\">human_time_diff()<\/a>  in PHP.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>from<\/em> <code>Moment | Date | string<\/code>: From date, in the WP timezone.<\/li>\n<li><em>to<\/em> <code>Moment | Date | string | undefined<\/code>: To date, formatted in the WP timezone.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>string<\/code>: Human-readable time difference.<\/li>\n<\/ul>\n<h3>isInTheFuture<\/h3>\n<p>Check whether a date is considered in the future according to the WordPress settings.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateValue<\/em> <code>string<\/code>: Date String or Date object in the Defined WP Timezone.<\/li>\n<\/ul>\n<p><em>Returns<\/em><\/p>\n<ul>\n<li><code>boolean<\/code>: Is in the future.<\/li>\n<\/ul>\n<h3>setSettings<\/h3>\n<p>Adds a locale to moment, using the format supplied by <code>wp_localize_script()<\/code>.<\/p>\n<p><em>Parameters<\/em><\/p>\n<ul>\n<li><em>dateSettings<\/em> <code>DateSettings<\/code>: Settings, including locale data.<\/li>\n<\/ul>\n<p><!-- END TOKEN(Autogenerated API docs) --><\/p>\n<h2>Contributing to this package<\/h2>\n<p>This is an individual package that&#8217;s part of the Gutenberg project. The project is organized as a monorepo. It&#8217;s made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to <a href=\"https:\/\/www.npmjs.com\/\">npm<\/a> and used by <a href=\"https:\/\/make.wordpress.org\/core\/\">WordPress<\/a> as well as other software projects.<\/p>\n<p>To find out more about contributing to this package or Gutenberg as a whole, please read the project&#8217;s main <a href=\"https:\/\/github.com\/WordPress\/gutenberg\/tree\/HEAD\/CONTRIBUTING.md\">contributor guide<\/a>.<\/p>\n","protected":false},"author":0,"featured_media":0,"parent":134521,"menu_order":264,"template":"","meta":{"footnotes":""},"class_list":["post-134547","blocks-handbook","type-blocks-handbook","status-publish","hentry","type-handbook"],"revision_note":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/blocks-handbook\/134547","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/blocks-handbook"}],"about":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/types\/blocks-handbook"}],"version-history":[{"count":15,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/blocks-handbook\/134547\/revisions"}],"predecessor-version":[{"id":155929,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/blocks-handbook\/134547\/revisions\/155929"}],"up":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/blocks-handbook\/134521"}],"wp:attachment":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/media?parent=134547"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}