エス技研

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.

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

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

  関連記事

get_categories、get_termsでカテゴリとタクソノミーのターム一覧の編集方法

get_categories()関数やget_terms()関数を使ってタクソノミーのタームを取得し検索処理の部品を作るプログラム作りその解説をしています。

Theme My Loginの旧バージョン(V6.4.17)のダウンロード場所の紹介
Theme My Loginの旧バージョン(V6.4.17)のダウンロード場所の紹介

Theme My Loginのバージョンアップ(V6.4系→V7.0系)で不具合が発生!問題を解消するには元バージョンにダウングレードだ!そんな時に必要となるV6.4系をダウンロードできるURLを紹介!

WordPressで月極駐車場検索サイトを構築し無料公開・使ったプラグインの紹介も

月極駐車場を検索するシステムをWordPressで構築。そのアナウンスと構築するために利用したプラグインの紹介。構築にどれくらいの期間がかかるのかの紹介。

WordPressの記事編集で文字が自動変換される要注意な文字列

記事を編集する際、入力した文字とは違う表示のされ方をする文字、アポストロフィ、ダブルクォート、円マーク、三点リーダ(…)など、その解説と対応方法です。

WordPressプログラム全体で定数や変数を利用する場合の設定方法

WordPressで関数を追加するときなど、全体で同じ変数を使いたいと思う場面の対処方法です。変数を記述する関数はfunctions.php、wp-config.phpのいずれか。

BizVektor環境の引越しでメニュー、バナーが消える不具合の対応方法解説

BizVektor環境の引越し方法と不具合が発生しやすい箇所の解説です。引っ越し作業をする際にURLやファイルのパスを置換する際の手順解説と対応方法についての解説です。

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

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

Meta ManagerでWordPressのキーワード、ディスクリプションを編集

WordPressの基本機能にないキーワード、ディスクリプションを編集するプラグインMeta Managerの解説です。

WordPress データベースを管理するための強い味方のプラグイン WP-DBMANAGER

データベースを管理するための強い見方のプラグイン「WP-DBMANAGER」の使い方の説明です。

WordPressのアップグレードの英語版と日本語版の公開のタイムラグは?

WordPressのアップグレードの英語版と日本語版の公開のタイムラグについて説明しています。