WordPress 的日期模块。

安装

安装该模块

npm install @wordpress/date --save

此包假设您的代码将在 ES2015+ 环境中运行。如果您使用的环境对这些语言特性和 API 支持有限或完全不支持，则应在代码中包含 @wordpress/babel-preset-default 随附的 polyfill。

API

date

格式化日期（类似于 PHP 中的 date()）。

相关资源

参数

  • dateFormat string: PHP 风格的格式化字符串。参见 php.net/date。
  • dateValue Moment | Date | string | number: 日期对象或字符串，可由 moment.js 解析。
  • timezone string: 输出结果时使用的时区或 UTC 偏移量。默认为站点时区。

返回值

  • string: 英文格式的日期。

dateI18n

格式化日期（类似于 PHP 中的 wp_date()），并将其翻译为站点的本地化语言。

向后兼容性说明：如果 timezone 设置为 true，则该函数的行为类似于 gmdateI18n。

相关资源

参数

  • dateFormat string: PHP 风格的格式化字符串。参见 php.net/date。
  • dateValue Moment | Date | string | number: 日期对象或字符串，可由 moment.js 解析。
  • timezone string | number | boolean: 输出结果时使用的时区或 UTC 偏移量。默认为站点时区。注意：boolean 类型实际上已弃用，但出于向后兼容原因仍受支持。

返回值

  • 格式化后的日期。

format

格式化日期。不更改日期的时区。

参数

  • dateFormat string: PHP 风格的格式化字符串。参见 php.net/date。
  • dateValue Moment | Date | string | number: 日期对象或字符串，可由 moment.js 解析。

返回值

  • 格式化后的日期。

getDate

从 WP 时区中的日期字符串创建并返回 JavaScript Date 对象。

参数

  • dateString string | null: 以 WP 时区格式化的日期。

返回值

  • Date

getSettings

返回当前定义的日期设置。

返回值

  • DateSettings: 设置，包括区域设置数据。

gmdate

格式化日期（类似于 PHP 中的 date()），使用 UTC 时区。

参数

  • dateFormat string: PHP 风格的格式化字符串。参见 php.net/date。
  • dateValue Moment | Date | string | number: 日期对象或字符串，可由 moment.js 解析。

返回值

  • 英文格式的日期。

gmdateI18n

格式化日期（类似于 PHP 中的 wp_date()），将其翻译为站点的本地化语言并使用 UTC 时区。

参数

  • dateFormat string: PHP 风格的格式化字符串。参见 php.net/date。
  • dateValue Moment | Date | string | number: 日期对象或字符串，可由 moment.js 解析。

返回值

  • 格式化后的日期。

humanTimeDiff

返回两个日期之间的人类可读时间差，类似于 PHP 中的 human_time_diff()。

参数

  • from Moment | Date | string | number: 起始日期，采用 WP 时区。
  • to Moment | Date | string | number: 结束日期，以 WP 时区格式化。

返回值

  • 人类可读的时间差。

isInTheFuture

检查根据 WordPress 设置，某个日期是否被视为未来时间。

参数

  • dateValue Date | string | number: 定义好的 WP 时区中的日期字符串或日期对象。

返回值

  • 是否为未来时间。

setSettings

向 moment 添加区域设置，使用由 wp_localize_script() 提供的格式。

参数

  • dateSettings DateSettings: 设置，包括区域设置数据。

为此包做出贡献

这是 Gutenberg 项目的一个独立包。该项目组织为 monorepo。它由多个自包含的软件包组成，每个包都有特定的用途。此 monorepo 中的包发布到 npm，并被 WordPress 以及其他软件项目使用。

要了解有关为此包或整个 Gutenberg 做出贡献的更多信息，请阅读项目的主 贡献者指南。