【WordPress】ショートコードを作成・使用する簡単な例|add_shortcode関数

WordPress では、投稿や固定ページ本文内の任意の箇所で、指定した関数を呼び出せるショートコードという機能があります。
今回は、そのショートコードを作成・使用する簡単な例となります。
簡単なショートコードの例
ショートコード機能を追加
ショートコードを利用するには、まず、ショートコード機能を追加するadd_shortcode関数をfunctions.phpに記述します。
以下が例となり、サムネイルサイズのアイキャッチ画像を出力するショートコードとなります。
function my_tagfunc(){
return get_the_post_thumbnail( get_the_ID(), 'thumbnail' );
}
add_shortcode( 'my_tag', 'my_tagfunc' );
add_shortcode関数の引数は、それぞれ以下となります。
- 第1引数にショートコードタグ名を指定
- 第2引数に、第1引数に指定したショートコードタグで実行する関数名を指定。
上記例では、ショートコードタグmy_tagを使用した際に、関数my_tagfuncを実行します。
追加したショートコードを使用
追加したショートコードを使用するには、add_shortcode関数の第1引数で指定したタグ名を[ ](角括弧)で囲んだ文字列を、管理画面から投稿や固定ページの本文内に入力して保存します。
上記で作成した関数を実行する場合には、以下のショートコードを本文内に入力します。それにより、ショートコードを入力した箇所に、サムネイルサイズのアイキャッチ画像が出力されます。
[my_tag]
任意の値を渡すショートコードについて
ショートコードを利用する際に、任意の値を渡すことも可能です。詳しくは以下のリンク先を参考にしてみてください。
- ショートコード – WordPress Codex 日本語版
- ショートコード API – WordPress Codex 日本語版
- 関数リファレンス/add shortcode – WordPress Codex 日本語版