経緯

WordPressのカスタムフィールドは使いにくいことで名高いので、それを解決するための様々なプラグインがあります。

ただ、これらを使うと、開発環境で構築したあと、本番環境に移すとき、また再設定しないといけないので、面倒くさいです。(DBフルダンプするとか、なんかしらのファイルを移行するとかでもいいかもしれませんが。

WordPressは出来る限りテーマで完結させて、WordPressのインストール自体はサーバ上で行って、テーマだけデプロイすればOKみたいにするのが好きです。

そこで、WordPressのカスタムフィールドをfunctions.phpで操作するやり方についてまとめておこうと思います。

やり方

この記事では以下のようなフォームを作っていこうと思います。

フィールド名 タイプ
composer text
lyrics textarea

ファイルを分ける

カスタムフィールドを作ろうとすると、それなりにコードの行数が増えるので、functions.phpではinclude分だけを書いて、ファイルを分けてしまうのがいいと思います。

例)

カスタムフィールドのフォームを作る

画面に表示するようにフックを作成

これは管理画面が表示される際にフックされる関数を指定するものです。ここでは、「管理画面が表示されるときにadd_music_fieldという関数を実行してね!」と言っています。

ボックスを作成

では、実際に実行するadd_music_fieldを定義していきましょう。

add_meta_boxは投稿画面の「タグ」や「カテゴリー」みたいな一つの箱を作るものです。

大事なのは第3〜5引数です。

第3引数では表示する内容を作成する関数名を指定します。ここで指定した関数で作られるHTMLが表示されます。

第4引数はpage or post, custom_post_typeのslugなどを設定します。他にもdashboardなど指定はできますが、これらは管理画面の投稿画面ではないところに使われるものなので、今回の用途ではこれらの3つしか使わないと思います。

第5引数は’normal’, ‘side’, ‘advanced’の3種類選択できますが、これらは表示位置が変わります。具体的にどうなるのかはいろいろ試してみてください。

HTMLを出力

以下のようにHTMLを出力します。

ここで、global $post$postを使うために必要なので、書いておきましょう。

ここまで、やっておけば、投稿画面にフォームが表示されると思います。

保存するためのコードを記述

投稿画面にフォームが表示されましたが、まだ、投稿しても保存はされません。

投稿されたとき、ちゃんと保存されるようにコードを書きましょう。

投稿された時のフックを作成

こうすることで、投稿を保存するときはsave_music_field関数を実行されます。

この関数の中で、カスタムフィールドを保存する処理を記述しましょう。

カスタムフィールドを保存

以下のようにすれば、カスタムフィールドを保存できます。配列には作ったフォームのname属性を記述しましょう。

まとめ

まとめると、以下のようなadmin/custom_field.phpが出来上がります。

これらを使えば、カスタムフィールドをプラグインに頼らず、テーマごとのものとして、作ることができます。

ご覧のとおり、結構コードが長くなるので、いい感じにファイルを分けてやらないと、管理が大変になってくるかと思いますので、functions.phpinclude文だけを記述して、いい感じにファイルを分けてやるのがスマートだと思います。