エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

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

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

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

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

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

 - WordPress

GoogleAdwords

GoogleAdwords

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

Comment

  1. 江村 より:

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

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

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

    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]
    を記述しましたが、反映されませんでした。

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

    • エス技研 より:

      江村さん、コメントありがとうございます。
      長期休暇中のため、返信が遅くなりました。

      ウェルカートのショートコードに関しては検証していませんが、サンプルで作成された方に関しては、以下のようになります。


      function shortcode1Func() {
      return "カート";
      }
      add_shortcode('shortcode1', 'shortcode1Func');
      add_filter('widget_text', 'do_shortcode' );

      これでショートコードとして「[shortcode1]」を編集すると、そこに「カート」と文字が編集されます。
      「add_filter...」は、「add_shortcode...」の代わりになるものではなく、ショートコードを処理する箇所が本文中だけではなく、ウィジェットのエリアでも処理しますよ、というフィルターを追加する記述になります。
      ですので、「add_shortcode...」の本来のショートコードの処理はすべて同じように記述します。

Message

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

※入力いただいたコメントは管理者の承認後に掲載されます。

  関連記事

WordPress csvインポート、エクスポートのプラグイン

WordPressから csvファイルをエクスポート、インポートする方法を紹介しています。

Advanced Custom Fields(ACF)のアドオン・ギャラリーの使い方解説

Advanced Custom Fieldsのアドオン・ギャラリーの解説記事。複数の画像を入力できる優れもので、画像のサイズ、容量などでの制限ができ、より厳密な管理が可能。

EWWW Image Optimizerで画像の圧縮でWordPressを高速化

ページ表示の高速化に使うEWWW Image Optimizerの紹介です。英語で書かれているために取っつきにくいですが設定は3カ所。画像の圧縮もワンクリック。超簡単!

Unveil Lazy LoadでWordPressを高速化!SEO効果絶大でPVもアップ!

WordPressの表示を高速化するUnveil Lazy Loadの紹介。利用するJSを見直し高速化を徹底的に追求したプラグイン。入れるだけで高速化するので使わない手はない!

Throws SPAM Awayでコメントスパム対策を完璧に。自動削除で運用の手間ゼロ

コメントスパム対策の決定版ともいうべきプラグイン。簡単な設定で自動的にスパムコメントを削除してくれるので煩わしい作業はゼロに。細かな設定も可能。

Advanced Custom Fields管理画面の全項目完全解説・カスタムフィールド決定版!

カスタムフィールドを設定する最高のプラグイン。設定できる項目を全て網羅して解説。投稿の項目だけではなく、カテゴリやユーザ情報の項目を増やすことにも使えます。

WordPressプラグインの3つのインストール方法解説

プラグインのインストール方法の特徴とおススメの方法を理由を含めて解説していきます。

プラグインが原因で起動しないWordPressを復旧させる方法解説

プラグインが原因で WordPressが起動できなくなった、ログインできなくなった場合の対処方法の解説です。

Google Code Prettifyの設定方法を解説。 Syntax Highlighterから乗換え、高速化にも最適

Google Code Prettifyでソースコードをきれいに編集する方法の解説。簡単設置とカスタマイズ設置の2つの方法を解説し、カスタマイズするポイントも解説。

WordPressのおすすめの確認画面付きお問い合わせフォームプラグイン・MW WP Form

MW WP Formは確認画面が付いているオススメのフォームプラグインです。企業サイトを CMSとして構築する際にも利用できる実力派です。