【無料 β版】NuniCustomFields｜WordPressプラグイン

テーマ開発者のためのWordPressカスタムフィールドプラグイン

Nunifuchisaka Custom Fields

日本語: https://nunifuchisaka.github.io/nunifuchisaka-custom-fields/

English: https://nunifuchisaka.github.io/nunifuchisaka-custom-fields/en/

■これは何？

投稿編集画面にカスタムフィールド（メタボックス）を追加する、軽量なWordPressプラグインです。

多くのカスタムフィールドプラグインは管理画面で設定するタイプですが、このプラグインはフィールドの定義をテーマの「functions.php」にコードで書く方式です。設定をデータベースに保存しないので、変更履歴をGitで追えたり、本番・ステージング・ローカルで設定がズレたりしません。

作者自身もテーマ制作をしており、「フィールド定義をコードで管理できる、こういうプラグインが欲しい」と感じて自作したものです。

■こんな人におすすめ

・テーマ制作でオリジナルの入力項目（サブタイトル、メインビジュアル、関連リンクなど）を追加したい人

・フィールド設定をコードで管理し、環境ごとの手動再設定をなくしたい人

・「くり返し入力欄（リピーター）」を無料で使いたい人（他の有名プラグインでは有料版限定のことが多い機能です）

・テンプレートに貼るだけの出力コードを自動生成してほしい人

・カスタムフィールドにリッチエディタ（WYSIWYG）を置きたい人

■できること

テーマの「functions.php」に１つのフィルターを書くだけで、以下のフィールド型に対応したメタボックスを追加できます。

・テキスト入力

・複数行テキスト

・セレクトボックス

・ラジオボタン

・チェックボックス（複数選択）

・画像選択（メディアライブラリから選択）

・投稿選択（他の投稿・固定ページへのリンクに）

・数値入力

・URL入力

・メールアドレス入力

・日付入力

・カラーピッカー

・リピーター（行の追加・削除・並べ替えができるくり返し入力欄）

・WYSIWYG（ビジュアル/テキスト切り替えできるリッチエディタ。太字・箇条書き・画像挿入などに対応）

保存時はフィールド型に応じたサニタイズ・バリデーションが自動で行われるので、改ざんされたリクエストや不正な値がそのままデータベースに入り込むのを防ぎます。

編集画面には「まとめて出力コードを取得」というパネルがあり、開くと登録したフィールドをテンプレートに出力するためのPHPコードがそのまま生成されます。コピペしてテンプレートに貼るだけで済み、毎回同じような出力コードを手で書く手間がありません。

保存完了時に発火するアクションフックも用意しているので、キャッシュの破棄や外部サービス連携もコードから差し込めます。

■使い方

1、プラグインをインストール・有効化する

2、テーマの「functions.php」で「ncf_register_fields」フィルターにフィールド定義の配列を返す

3、対象の投稿編集画面にメタボックスが表示され、保存・サニタイズは自動で行われる

4、「get_post_meta()」でテンプレート側から値を取得する（メタキーは「ncf_」+フィールドキー）

■注意点

・フィールドの追加・編集は管理画面からではなく、テーマ側のコードで行います。PHPの基礎知識が必要です。

・リピーターは1階層のみ対応です（リピーターの中にリピーターは使えません。WYSIWYG型もリピーターの中では使えません）。

・WYSIWYG型はscriptやiframeなど一部のタグが自動的に除去されます。SNS埋め込みなど特殊な用途が必要な場合はコールバックでの調整が必要です。

■動作環境

・WordPress 6.0以上（7.0まで動作確認済み）

・PHP 7.4以上