はじめに

Drupalの日付や時刻を扱う際、簡単なものであれば 環境設定 > 地域と言語内の「日付と時間のフォーマット」から、日付や時刻のFormatを作成することができますよね。

↑↑ がピンとこない人はこちら

ただ、和暦表示や年度変換など、Drupal標準だと対応できないものもあります。

こんな場面で対応できるのが、「FieldFormatter」です。

今回は「Field Formatter」の実装について触れてみたいと思います。

0. 前提(対象)

Drupalのモジュール開発をしたことがある
PluginAPIへの理解

1. Field Formatter とは

Fieldのデータをフォーマットし、表示できるようにするためのものです。

今回の「和暦表示」や「年度変換」もHOOKシステムで局所的な対応をしてもいいですが、多くの箇所で使うようなシステムであればPluginとして実装する意義がありそうですよね。

2. 環境

今回は、以下のバージョンで実装を行いました。
Drupal 10.2.7
Drush 12.5

3. 実装

ER図

今回のテーブル構成はこんな感じ。

Member(Drupal標準のUserエンティティを使用しても可)

Field	Type
name	プレーンテキスト
field_birthday	日付と時刻（日付のみ）

実装

それでは実装してみましょー。

手順１. ModuleのSetup。

drushがいい感じのものを用意してくれています。
ここまではCLI操作のみでできます。

drush generate plugin:field:formatter

対話形式でModule名やClass名を指定してください。

 Module machine name:
 ➤ sample_module_formatter

 Plugin label:
 ➤ SampleModule(和暦対応)

 Plugin ID:
 ➤ japanese_era_date

 Plugin class [WarekiFormatter]:
 ➤ JapaneseEraDateFormatter

 Make the formatter configurable? [No]:
 ➤ No

{root}/web/modules/*を確認してみてください。
たったコマンド一つでモジュールが用意できたと思います。

有効化もお忘れなく。

drush en sample_module_formatter

手順2. Pluginを日付フィールドに対応させる

Pluginを「日付と時刻」フィールドタイプを指定する必要があります。
drush generateで作成されたFormatterファイル内のAnnotationを指定します。

JapaneseEraDateFormatter.php

/**
 * 和暦対応.
 *
 * @FieldFormatter(
 *   id = "japanese_era_date",
 *   label = @Translation("和暦対応"),
 *   field_types = {"datetime"},   // ← ここ
 * )
 */
final class JapaneseEraDateFormatter extends FormatterBase {
  // ~ 省略 ~
}

デフォルトでは、「string」になっているはずです。

手順3. GUIでFormatterを選択

「日付と時刻」フィールドを設定しているエンティティタイプのビューモード設定画面にて、作成したFormattarを選択してみましょう。
手順2のAnnotation指定に間違いがなければ、この時点で選択ができるようになります。

↑↑ 「和暦対応」という選択肢が増えていますね。

選択して保存しましょう。

手順4. 出力変更の実装

JapaneseEraDateFormatter::viewElementsメソッド内で、#markupを指定していますよね。
こちらを加工すれば出力が変わるようになっています。

JapaneseEraDateFormatter

/**
 * {@inheritdoc}
 */
public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];
  foreach ($items as $delta => $item) {
    $date = new DrupalDateTime($item->date);

    // Convert the date to Japanese era format here.
    $markup = $this->convertDateTime($date);

    $elements[$delta] = ['#markup' => $markup];
  }

  return $elements;
}

/**
 * 日付データの加工.
 */
private function convertDateTime(DrupalDateTime $date) {
  // 日付のフォーマット.
  $date_format = $date->format('Y年m月d日');
  // 元号.
  $era = Era::fromDateTime($date);
  $era_format = $era->getJapaneseName();

  return $date_format . '(' . $era_format . '生まれ)';
}

foreach文内の$itemにフィールド値に関する情報が入っています。
デバッグして確認してみてください。

※ 元号変換ロジックについては、本記事の趣旨がずれてきますので解説を省きます。

Githubにサンプルコードを載せていますので気になる方はぜひ活用ください。

実装は完了です。

4. 表示確認

実際に表示を見てみましょう。

ちゃんと表示されていますね。実装がうまくいっているようです。（よかった）

はい、私は平成12年生まれです。

5. コード

今回のコードはGithubにあげています。
参考になれば幸いです。

6. まとめ

いかがでしたか？

今回は、元号を題材に「日付」フィールドの入力値に応じてFormattarで表示を変える方法を紹介しました。

もちろん、フィールドのデータのみならずEntityの情報を拾うことができますので他のフィールドとの組み合わせで表示のカスタマイズができたりもするかと思います。

元号変換ロジックについては以下の記事で解説しています。こちらもぜひ。