カスタムフィールドに保存した値を投稿本文内へショートコードで呼び出すコード(メモ)

カスタムフィールドに保存した値を投稿本文内へショートコードで呼び出すコード(メモ)

WordPressの便利機能の1つであるカスタムフィールド。

通常は以下のようにして使うことが多いのではないでしょうか?

  1. プラグインやコードを使って入力欄を用意して、値を入力・保存しておく
  2. カスタムフィールドの値を出力して表示させるテンプレートを用意する
  3. テンプレート内に呼び出すコードを挿入する

WordPressでは、セキュリティ対策として、投稿や固定ページ本文内にPHPコードを直接記述できないようになっているので、この手順が至極スタンダードな方法なのですが、できれば自由に本文内で呼び出せたら便利ですよね?

そこで今回は、簡単なコードをテーマのfunctions.phpへ追加するだけで、カスタムフィールドに保存されている値を本文内へショートコードで出力する方法を紹介します。

ついでに別の投稿にあるカスタムフィールドの値も引っ張り出して表示できるようにしているので、比較表などを作る場合にも便利だと思います。

データのとり方(保存方法)が特異である「Advanced Custom Fields」プラグインの情報出力については対応していません

なお、本ページの方法を実践するには、テーマのfunctions.phpへのコード追記が必要です。スキルに自身がない方は文末で紹介しているプラグインの使用をおすすめします。

ページ上部へ戻る▲

カスタムフィールドの値を呼び出すショートコードの作成方法

カスタムフィールドに挿入した値を投稿本文上で表示するには

  1. カスタムフィールドの値を呼び出すためのショートコードを生成するプログラムを追加する
  2. 1で作成したショートードを本文内へ挿入して、値を呼び出す

という作業が必要です。順に説明していきます。

ショートコードで出力するためのプログラムをテーマへ追加する

え?こんなに簡単なコードでいいの?位のコードを有効化しているテーマのfunctions.phpへ追記するだけで、カスタムフィールドの値をショートコードで出力することができます。

本ページのコードを使ってエラーや不具合が発生しても責任を負いかねますので、了承の上使用ください

クリックしてコードの内容を表示

/*** fieldショートコードでカスタムフィールドの値を表示 ***/
function ha_show_shortcode_field($atts){
	extract(shortcode_atts(array(
	'post_id' => '',
	'field' => '',
	), $atts));

	if(!empty($field)){
		global $post;
		$post_id = ('' === $post_id) ? $post->ID : $post_id;
		return get_post_meta($post_id, $field, true);
	}
}
add_shortcode('c-field', 'ha_show_shortcode_field');

基本的には、Get Custom Field Value with Shortcodeというページのコードを参考にさせていただいていますが、以下のような点に工夫を加えています。

  • ショートコード内の「field」パラメーターにカスタムフィールドキー(名前)が指定されていない場合は何も出力しない
  • 引っ張る投稿のカスタムフィールドにカスタムフィールドキーがない(値がない)場合には何も出力しない

こうしておくことで、誤ったキーを指定した場合や、値がない場合でもノーメンテナンスで使うことができます。

つまり、上記コードを削除しなければ、本文内へ記述したショートコードが無効の場合には何も表示されないことになるため、そのカスタムフィールド名を使わなくなった場合でも、過去の投稿をすべて見直すといった作業をする必要がないように配慮しています。

カスタムフィールドの値をショートコードで表示させる

投稿本文内へ以下のショートコードを追加して、パラメーターを設定すれば、カスタムフィールドに保存してある値を表示できます。

[c-field  field='〇〇' post_id='××']
  • パラメーター:field=’〇〇’の〇〇には、カスタムフィールドのキーを入力します
  • パラメーター:post_id=’××’の××には、特定の投稿IDを入力します(省略すると現在の投稿IDのカスタムフィールド値を表示します)

コードの追加が不安な方にはプラグインもあります

前述の通り、簡単なコードを有効化しているテーマのfunctions.phpへ追加すれば、カスタムフィールドの値をショートコードで出力できるようになりますが、中にはコードの追加は不安という方もみえるでしょう。

そんな時はWordPress公式サイト内で配布されている「Embed Custom Field」というプラグインを追加すれば同じことができるようになります。

以下に私が「Embed Custom Field」を試用した際の印象などを書いたレポートページがありますので、参考にしてみてください。

カスタムフィールドに入力した値をショートコードで本文内へ表示するプラグイン「Embed Custom Field」


本ページで紹介しているコードは、以下のページ参考に個人的に使いやすい形へ変更したものです。

Get Custom Field Value with Shortcode

著:清水 由規, 著:清水 久美子, 著:鈴木 力哉, 著:西岡 由美, 監修:星野 邦敏, 監修:吉田 裕介
¥2,948 (2022/09/22 08:50時点 | Amazon調べ)
著:Mana
¥2,200 (2022/09/22 08:50時点 | Amazon調べ)
Avatar photo

作者:

WordPress用テーマ「HABONE」の開発、プラグインやテーマの翻訳、WordPressの使い方やカスタマイズ方法などの情報を配信しています。

年齢:50代 趣味/園芸・ペット・卓球