インストール

モジュールをインストールします 

  1. npm install @wordpress/date --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。このような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含める必要があります。

API

日付

日付をフォーマットします（PHPのdate()のように）。

関連情報

パラメータ

  • dateFormat string: PHPスタイルのフォーマット文字列。php.net/dateを参照してください。
  • dateValue Moment | Date | string | undefined: moment.jsで解析可能な日付オブジェクトまたは文字列。
  • timezone string | number | undefined: 結果を出力するタイムゾーンまたはUTCオフセット。サイトのタイムゾーンがデフォルトです。

戻り値

  • string: 英語でフォーマットされた日付。

dateI18n

日付をフォーマットし（PHPのwp_date()のように）、サイトのロケールに翻訳します。

後方互換性の通知: timezoneがtrueに設定されている場合、関数はgmdateI18nのように動作します。

関連情報

パラメータ

  • dateFormat string: PHPスタイルのフォーマット文字列。php.net/dateを参照してください。
  • dateValue Moment | Date | string | undefined: moment.jsで解析可能な日付オブジェクトまたは文字列。
  • timezone string | number | boolean | undefined: 結果を出力するタイムゾーンまたはUTCオフセット。サイトのタイムゾーンがデフォルトです。通知: booleanは実質的に非推奨ですが、後方互換性の理由からまだサポートされています。

戻り値

  • string: フォーマットされた日付。

フォーマット

日付をフォーマットします。日付のタイムゾーンは変更しません。

パラメータ

  • dateFormat string: PHPスタイルのフォーマット文字列。php.net/dateを参照してください。
  • dateValue Moment | Date | string | undefined: moment.jsで解析可能な日付オブジェクトまたは文字列。

戻り値

  • string: フォーマットされた日付。

getDate

WPタイムゾーンの日付文字列からJavaScriptのDateオブジェクトを作成して返します。

パラメータ

  • dateString string?: WPタイムゾーンでフォーマットされた日付。

戻り値

  • Date: 日付

getSettings

現在定義されている日付設定を返します。

戻り値

  • DateSettings: 設定、ロケールデータを含む。

gmdate

日付をフォーマットします（PHPのdate()のように）、UTCタイムゾーンで。

パラメータ

  • dateFormat string: PHPスタイルのフォーマット文字列。php.net/dateを参照してください。
  • dateValue Moment | Date | string | undefined: moment.jsで解析可能な日付オブジェクトまたは文字列。

戻り値

  • string: 英語でフォーマットされた日付。

gmdateI18n

日付をフォーマットします（PHPのwp_date()のように）、サイトのロケールに翻訳し、UTCタイムゾーンを使用します。

パラメータ

  • dateFormat string: PHPスタイルのフォーマット文字列。php.net/dateを参照してください。
  • dateValue Moment | Date | string | undefined: moment.jsで解析可能な日付オブジェクトまたは文字列。

戻り値

  • string: フォーマットされた日付。

humanTimeDiff

2つの日付の間の人間が読みやすい時間差を返します。PHPのhuman_time_diff()のように。

パラメータ

  • from Moment | Date | string: WPタイムゾーンの開始日。
  • to Moment | Date | string | undefined: WPタイムゾーンでフォーマットされた終了日。

戻り値

  • string: 人間が読みやすい時間差。

isInTheFuture

日付がWordPressの設定に従って未来と見なされるかどうかを確認します。

パラメータ

  • dateValue string: 定義されたWPタイムゾーンの日付文字列または日付オブジェクト。

戻り値

  • boolean: 未来にあるかどうか。

setSettings

wp_localize_script()で提供されたフォーマットを使用してmomentにロケールを追加します。

パラメータ

  • dateSettings DateSettings: 設定、ロケールデータを含む。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。