WordPressのウィジェットでショートコードを使う方法add_filter

2014/05/21 2014/07/06

WordPressのウィジェットでショートコードを実行する

ショートコードとは？

　
投稿ページや固定ページで PHPの実行結果を編集したい場合には add_shortcode関数を利用したショートコードを使用します。
　
そのショートコードの詳細な使い方については「WordPress投稿にPHPを記述するショートコードの使い方add_shortcode」に詳しく書いていますのでそちらをご覧ください。
　
　
2014.06.07　追記
ウィジェットの設定に関しては、「WordPressのサイドバー（サイドナビ）はウィジェットで編集」に書いていますので、併せて参照ください。
　
　

ウィジェットでショートコードを使えるようにする方法

　
上記の使い方の通り「functions.php」に関数とショートコードを呼び出す add_shortcodeを記述すれば、投稿ページや固定ページでは PHPの処理を実行した結果が編集されますので、ウィジェットでも処理されるはず、と思っていたのですが、ウィジェットでは動かないのです。
　
実は、ショートコードをウィジェットで動かすためには、それ用の add_filterという記述をする必要があったのです。
　
それは、下記の 1行を functions.phpに追記することです。
　
————————————

add_filter('widget_text', 'do_shortcode' );

1	add_filter('widget_text', 'do_shortcode' );

————————————
　
　
add_filterを書いておけばいい、それが分かってしまえば実に簡単です。
　
上記の add_filterの 1行を記述する場所は functions.phpの中であればどこでも構いませんが、分からなくならないように、ショートコードの関数を記述する数行上くらいに書いておくといいでしょう。
　
　
ちなみに、functions.phpが置いてある場所は、下記のファイルになります。

/{WordPressがインストールされている場所}/wp-content/themes/{テーマ名}/functions.php

1	/{WordPressがインストールされている場所}/wp-content/themes/{テーマ名}/functions.php

　
詳しくは、「WordPressの functions.phpがある場所」にも記事を書いています。
　
　

ウィジェットでショートコードを使えるようにする方法・その２

　
ウィジェットにショートコードを記述した場合、ショートコードが処理されず、ショートコードのコードそのものが表示されてしまうのは、ショートコードのパース処理が通らないことでプレーンテキストとして見られてしまうことに原因があります。
　
そのため、下記のように、ショートコードを実行する関数を通すことで情報を取得し、echoで表示させる、という方法もあります。
　

<?php echo( do_shortcode( '[shortcode1]' ) ); ?>

1	<?php echo( do_shortcode( '[shortcode1]' ) ); ?>

　
※「shortcode1」は、「WordPress投稿にPHPを記述するショートコードの使い方add_shortcode」で作成したショートコードの関数です。
　
こちらの方法は、テンプレートでショートコードを表示させる際に利用する処理と同じですね。

- WordPress

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Comment

江村より:

2015年8月10日 11:59 AM

初めまして
江村と申します。

記事を拝見した中で質問がございます。

私もウィジェットにショートコードを表示したいと考えています。

add_filter(‘widget_text’, ‘do_shortcode’ );
をfunctions.phpに記述し、
ウェルカートのカートに入れるのショートコード
[button_to_cart item=”h-001″ sku=”h-001-01″ value=””]
をウィジェットに表示したいので、テキストに記述しましたが、
プレーンテキストとして認識されました。

ですので、
function shortcode1Func() {
return “カート”;
}
add_shortcode((‘widget_text’, ‘do_shortcode’ );
と記述し、
ウィジェットのテキストに
[shortcode1]
を記述しましたが、反映されませんでした。

何か間違っている所はありますか？
ご多忙とは存じますが、宜しくお願いします。

返信
- エス技研より:
  
  2015年8月13日 8:45 AM
  
  江村さん、コメントありがとうございます。
  長期休暇中のため、返信が遅くなりました。
  
  ウェルカートのショートコードに関しては検証していませんが、サンプルで作成された方に関しては、以下のようになります。
  
  function shortcode1Func() { return "カート"; } add_shortcode('shortcode1', 'shortcode1Func'); add_filter('widget_text', 'do_shortcode' );
  
  これでショートコードとして「[shortcode1]」を編集すると、そこに「カート」と文字が編集されます。
  「add_filter．．．」は、「add_shortcode．．．」の代わりになるものではなく、ショートコードを処理する箇所が本文中だけではなく、ウィジェットのエリアでも処理しますよ、というフィルターを追加する記述になります。
  ですので、「add_shortcode．．．」の本来のショートコードの処理はすべて同じように記述します。
  
  返信