Advanced Custom Fieldsでカスタムバリデーションを実装する

WordPressの管理画面に独自の入力欄を追加したいときに便利なのが、プラグイン「Advanced Custom Fields（ACF）」です。テキスト・日付・画像・セレクトボックスなどのカスタムフィールドを簡単に設置でき、業務に合わせた管理画面を構築できます。

ただし、自由に入力できるだけでは操作ミスや不整合が起こりやすくなります。便利なカスタムフィールドも、正しく入力されなければ意味がありません。

そこで重要になるのがバリデーション（入力チェック）です。この記事では、より柔軟な制御が可能な「カスタムバリデーション」の実装方法をコードとともに紹介します。

デフォルトのバリデーション機能でできること

ACFにはデフォルトのバリデーション機能があります。デフォルトのバリデーション機能では、各フィールドに次のようなバリデーションを設定できます。

• 必須チェック（空欄を許可しない）
• 文字数制限（最小・最大文字数）
• 形式チェック（メールアドレス、URLなど）
• 数値の範囲チェック（最小値・最大値）
• ファイルの種類・サイズ制限（画像やPDFなど）

これらはフィールド編集画面の「検証」タブから設定できます。

形式チェックなど一部のバリデーションはフィールドタイプに応じて自動で適用されます。バリデーションに通らなければ投稿の公開や更新はできず、入力欄にエラーメッセージが表示されます。

多くの場合はデフォルトのバリデーションで十分ですが、「未来の日付しか選べないようにする」といった条件には対応できません。

acf/validate_valueで独自のバリデーションを追加する

デフォルトのバリデーションで対応できない条件をチェックするには、ACFが提供するacf/validate_valueフィルターを利用します。

ACF | acf/validate_value

Used to perform validation on the field's $value before being saved.

www.advancedcustomfields.com

基本構文は以下のとおりです。テーマのfunctions.phpに記述します。

1
add_filter(
2
  // 'acf/validate_value/name=...' の部分で対象フィールドを指定（name=の代わりにkey=やtype=も使える）
3
  'acf/validate_value/name=フィールド名',
4
  function ( $valid, $value, $field, $input ) {
5
    // $valid: 現在のバリデーション結果（trueまたはエラーメッセージ）
6
    // $value: フィールドに入力された値
7
    // $field: 対象フィールドの設定情報（ラベル、タイプなど）
8
    // $input: フォーム上のname属性。POSTデータの識別に使える
9

10
    // バリデーションに成功した場合はtrueを、失敗した場合はfalseまたはエラーメッセージを返す
11
    return $valid;
12
  },
13
  10,
14
  4
15
);

add_filter()の第1引数に'acf/validate_value/name=フィールド名'を渡してバリデーション対象のフィールドを指定し、第2引数にバリデーション関数を渡します。

バリデーション関数は投稿の保存直前に実行されます。バリデーション関数がtrueを返せば保存が続行され、falseまたはエラーメッセージを返せば保存が失敗します。

エラーメッセージを返した場合、投稿画面にエラーメッセージが表示されます。

acf/validate_valueフィルターを利用すれば、次のような柔軟なチェックが可能になります。

• 入力値が指定フォーマットに一致しているか
• 他のフィールドとの値の比較（例：開始日 < 終了日）

次のセクションでは、「未来の日付しか選べないようにする」バリデーションの実装例を紹介します。

実装例①：締切日が現在より未来であることをチェック

カスタムフィールド締切日の入力値が未来の日付であることをカスタムバリデーションでチェックします。

カスタムフィールドの設定は以下のとおりです。

このままだと過去の日付も選択できてしまうため、次のコードをfunctions.phpに追加します。

1
add_filter(
2
  'acf/validate_value/name=deadline', // バリデーションを適用するフィールド名を指定
3
  function ( $valid, $value ) {
4
    // 既にバリデーションが失敗している場合は、その結果をそのまま返す
5
    if ( ! $valid ) {
6
      return $valid;
7
    }
8

9
    // 入力された日付が現在より未来の日付であるかをチェック
10
    return new DateTime() < new DateTime( $value )
11
      ? $valid
12
      : '締切日は現在より未来の日付を選択してください。';
13
  },
14
  10,
15
  4
16
);

このコードでは、締切日に入力された日付が現在よりも未来かどうかをDateTimeで比較しています。過去の日付であれば、エラーメッセージを返してバリデーションエラーとします。

このようにカスタムバリデーションを活用することで、ユーザーの入力ミスを防ぎ正しい情報だけが保存されるように制御できます。

実装例②：開始日と終了日の前後関係をチェック

次に、2つの日付フィールドの前後関係をチェックするケースを紹介します。ここでは開始日と終了日という2つのカスタムフィールドを使用します。

カスタムフィールドの設定は以下のとおりです。

functions.phpに、次のコードを追加します。

1
add_filter(
2
  'acf/validate_value/name=end_date',
3
  function ( $valid, $value ) {
4
    // 既にバリデーションが失敗している場合は、その結果をそのまま返す
5
    if ( ! $valid ) {
6
      return $valid;
7
    }
8

9
    // POSTデータから開始日を取得
10
    $post_id          = isset( $_POST['post_id'] ) ? absint( $_POST['post_id'] ) : 0;
11
    $start_date_field = get_field_object( 'start_date', $post_id );
12
    $start_date_key   = $start_date_field['key'] ?? null;
13
    $start_date       = isset( $_POST['acf'][ $start_date_key ] ) ? sanitize_text_field( wp_unslash( $_POST['acf'][ $start_date_key ] ) ) : null;
14

15
    // 開始日が存在し、かつ終了日が開始日より後の日付であるかをチェック
16
    return $start_date && new DateTime( $start_date ) < new DateTime( $value )
17
      ? $valid
18
      : '終了日は開始日より後の日付を選択してください。';
19
  },
20
  10,
21
  4
22
);

ここでは終了日がバリデーション対象のため終了日の値は$valueとして取得できますが、開始日は$_POSTから取得する必要があります。get_field_object()でフィールドキーを取得し配列から開始日の値を取り出します。2つの値をDateTimeで比較し、終了日が開始日より前の日付であればエラーメッセージを返すようにしています。

このように開始日と終了日のような複数フィールド間の関係も、カスタムバリデーションを使えば柔軟にチェックできます。

まとめ

• 簡単なチェックならACFのデフォルトのバリデーション機能で対応できる
• acf/validate_valueフィルターで独自のバリデーションを追加できる
• 独自バリデーションでは単体の値だけでなく、複数フィールド間の関係もチェックできる

検証環境とサンプルコード

今回のサンプルコードはGitHubで公開しています。