このプラグインは WordPress の最新3回のメジャーリリースに対してテストされていません。もうメンテナンスやサポートがされていないかもしれず、最新バージョンの WordPress で使用した場合は互換性の問題が発生する可能性があります。

Debug Bar Shortcodes

説明

Debug Bar Shortcodes は、現在のリクエスト用に登録されたショートコードを表示する、新しいパネルを Debug Bar に追加します。

加えて、以下のようなことも表示されます:

  • ショートコードによって呼び出される関数/メソッド
  • ショートコードが、現在の投稿/ページ/投稿タイプで使用されるかどうか、またどのように使用されるか (個別の場合のみ)
  • 説明、どのパラメータを受け取るか、自己閉じ型か否か、など、ショートコードについて利用可能な追加情報。
    独自のショートコードについて表示される追加情報を制御したいですか ? できます ! 詳しくは FAQ をご覧ください。
  • ショートコードが使用されているすべてのページ/投稿/その他を検索する

このプラグインは LRH-Shortcode list および Shortcake/Shortcode UIプラグインと互換性があります。これらのプラグインに提供されたショートコードに関する追加情報は、このプラグインでも反映され、利用できるようになります。

ショートコードを理解することが、なぜ、役に立つのですか ?

私が思いつく典型的な使い方は、いくつもあります:

  • あなたがブログの作者の場合:

    • 投稿/ページで使用できるショートコードを知るためです。
    • プラグインを切り替えたり、プラグインを削除した場合、どの投稿/ページで古いショートコードを削除/置換する必要があるかを知ることができます。
  • あなたが web デザイナー / web マスターの場合:

    • プラグインを切り替えたり、プラグインを削除した場合、どの投稿/ページで古いショートコードを削除/置換する必要があるかを知ることができます。
    • テーマファイルで使用できるショートコードを知るためです。
    • ウェブサイト固有のショートコードとの、名前の衝突を避けるためです。
  • あなたが開発者の場合:

    • 他のプラグイン/テーマによって登録されたショートコードとの、名前の衝突を避けるためです。
    • ショートコードが正しく登録されているか、条件分岐が正しく適用されているかをチェックするためです。

重要

このプラグインを使用するには、Debug Bar プラグインがインストールされ、有効になっている必要があります。

謝辞

このプラグインが気に入ったら、評価やレビューをお願いします。このプラグインをより良くするためのアイデアやバグを見つけた場合は、サポートフォーラムまたは GitHubリポジトリで報告してください。

スクリーンショット

  • ショートコードを表示する Debug Bar
  • Web フロントエンド単数でショートコードを表示する Debug Bar
  • Debug Bar Shortcodes – 作者によって提供された場合の、ショートコードの詳細情報の例
  • Debug Bar Shortcodes – ショートコードのドキュメントから取得した情報に基づく、ショートコードの詳細情報の例
  • Debug Bar Shortcodes – サイト全体に見られるショートコードの使用例

インストール

  1. インストールされてない場合は、 Debug Bar (https://wordpress.org/plugins/debug-bar/) をインストールします。
  2. このプラグインの .zip ファイルを解凍し、その内容を /wp-content/plugins/ ディレクトリにアップロードします。または、WordPress インストール内の Plugin ディレクトリから直接インストールすることもできます。
  3. 「プラグイン」メニューからプラグインを有効化します。

このプラグインを本番サイトで使用する際はご注意ください。このプラグインは開発目的のために設計されています。

FAQ

本番のサイトで使用できますか ?

このプラグインは開発目的でのみ使用することを意図していますが、本番サイトで使用しても問題は発生しません。

ショートコードとは ?

ショートコードは、WordPress 特有のコードで、わずかな労力で気の利いたことができるようになります。ショートコードは、ファイルを埋め込んだり、通常は複雑で醜いコードをたくさん必要とするオブジェクトを、たった1行で作成できます。ショートコード = ショートカットです。
ソース

WordPress でショートコードを使用する方法については、以下を参照してください:
WP Codex 上のショートコード
WP Codex 上の Shortcode API

私のショートコードがリストにないのは、なぜ ?

2つの可能性があります:

  • ショートコードが ShortCode API を使用して正しく登録されていない可能性があります。
  • あるいは、ショートコードが条件付きでしか登録されておらず、現在のページがその条件を満たしていないのかもしれません。
ショートコードの数は、リクエストされたページによって異なります。どうして ?

前の回答を参照してください。

ページ *xyz* でショートコード *abc* を使っているのですが、使用されていると表示されません !

ページ内でショートコードが使用されているかどうかを判断するために、投稿内容のみが評価されます。他のエリア (例: ウィジェット) やテーマ経由でショートコードを使用してページにコンテンツを追加した場合、それらの使用は認識されません。

私が作っているテーマで、これらのショートコードを使うことはできますか ?

一般的には可能です。ただし、使用する前に必ずショートコードが登録されているかチェックすることをお忘れなく! すべてのページで使えるとは限りませんし、すべての WP インストールで使えるとも限りません。

if ( shortcode_exists( 'shortcode' ) ) {
    /* Your code here */
    // echo do_shortcode( 'some content containing a [shortcode /]' );
}
私は開発者で、このプラグインによって表示される自分のショートコードに関する情報を充実させたいと思っています。

できる限り簡単で苦痛のないようにしたつもりです。

フィルタを追加するだけで、このプラグインが持つショートコードに関する情報を充実させることができます。最も簡単な方法は、ショートコードにのみ適用される db_shortcodes_info_{shortcode} フィルターを使うことです。

add_filter( 'db_shortcodes_info_{your_shortcode}', 'filter_my_shortcode_info' );
function filter_my_shortcode_info( $info ) {
    // enrich the object
    return $info;
}

あなたが受け取り、返すことが期待されている $info オブジェクトは、ショートコードに関する現在の既知の情報を含んでいます。

$info is expected to contain (a selection of) the following parameters:
stdClass(
    $name         = (string) 'Friendly name for your shortcode',
    $description  = (string) 'Description of your shortcode',
    $self_closing = (bool) true/bool, // whether the shortcode is self-closing
    $parameters   = array(
        'required'      => array(
            (string) 'attribute_name'       => (string) 'attribute description',
        ),
        'optional'      => array(
            (string) 'attribute_name'       => (string) 'attribute description',
        ),
    ),
    $info_url     = '',
)

LHR-Shortcode list プラグイン用の sim_{shortcode} フィルタを使用して同様の情報をすでに提供している場合は、余計なことをする必要はなく、その情報はこのプラグインによってピックアップされます。

同様に、Shortcake/Shortcode UI 機能プラグインに情報を提供した場合、その情報は利用可能な情報を充実させるために自動的に使用されます。

ちょっと待って – フィルターの挙動が変わった ?!?

プラグインのバージョン1.0では、フィルターに渡される変数 $info は配列でした。これはバージョン2.0で変更されました。

これが後方互換性の破壊であることは承知しています。しかし、かなり広範囲に検索してみましたが、このフィルターを使用しているプラグインは (まだ) 見つかりませんでした。したがって、この後方互換性の破壊はほとんど影響がなく、安全に実装できると判断しました。

既にフィルターがあるのなら、あなたのプラグインやテーマを見つけられませんでした! でも心配しないでください。コードをアップグレードするのはとても簡単です。
まず最初に、コード内の add_filter() フックと関数のシグネチャを、2つの変数を受け取るように変更する必要があります。最初の変数は新しいオブジェクトになりますが、2番目の変数は1.0で渡されたフォーマットの配列のままなので、情報を充実させるために関数内でそれを使い続けることができます。
次に、このプラグインが使用するのはオブジェクトのプロパティだけなので、return で配列をオブジェクトにキャストするだけで、再び機能するようになります。

Old code for v1.0:

add_filter( 'db_shortcodes_info_{your_shortcode}', 'filter_my_shortcode_info' );
function filter_my_shortcode_info( $info ) {
    // enrich the array
    return $info;
}

Updated code for v2.0:

add_filter( 'db_shortcodes_info_{your_shortcode}', 'filter_my_shortcode_info', 10, 2 );
function filter_my_shortcode_info( $info_object, $info ) {
    // enrich the array
    return (object) $info;
}
プラグインが有効にならないのは、なぜ ?

プラグインページの一番上にある美しく赤いバーに書いてあることを読みましたか ? そこに書いてある通り、このプラグインが動作するには Debug Bar プラグインが有効である必要があります。Debug Bar プラグインが有効でない場合、このプラグインは自動的に無効化されます。

評価

3件のレビューをすべて表示

貢献者と開発者

Debug Bar Shortcodes はオープンソースソフトウェアです。以下の人々がこのプラグインに貢献しています。

貢献者

“Debug Bar Shortcodes” は1ロケールに翻訳されています。 翻訳者のみなさん、翻訳へのご協力ありがとうございます。

“Debug Bar Shortcodes” をあなたの言語に翻訳しましょう。

開発に興味がありますか ?

コードを閲覧するか、SVN リポジトリをチェックするか、開発ログRSS で購読してみてください。

変更履歴

2.0.3 (2016-04-29)

  • must-use プラグイン・ディレクトリにあるプラグインを使用することで、text-domainのロードを互換性のあるものにします。
  • 細かな手入れ。
  • Tested & found compatible WP 4.5.

2.0.2 (2016-01-10)

  • WordPress 4.2以降動作しなくなっていた AJAX リクエスト用のスピナーを修正。

2.0.1 (2015-12-26)

  • Twenty-Sixteen テーマとの組み合わせで、フロントエンドのテーブルレイアウトがおかしかったのを修正。

2.0 (2015-12-14)

重要: プラグイン/テーマの開発者で、'db_shortcodes_info_{your_shortcode}' フィルタを使用していた場合: このフィルタの挙動は、配列渡しからオブジェクト渡しに変わりました。この変更に対処する方法については、FAQ を読んでください!

  • 機能強化: Shortcake から入手可能なショートコード情報のサポートを追加。
  • 機能強化: 少なくとも、同じディレクトリに複数のプラグインが見つかった場合は、プラグインのURLを検出するようにする。
  • バグ修正: コールバックとしてクロージャを持つショートコードの情報が取得されていなかった。(クロージャに対してリフレクションオブジェクトが取得されていなかった。)
  • 互換性の修正: WordPress 4.4用のレイアウトを修正するために html をマイナーチェンジ。
  • 利便性: テーブルヘッダの揃えを改善。
  • 利便性: タイトルだけでなく、行の上にカーソルを置くと、行のアクションが表示されるようになった。
  • 利便性: Glotpress / WordPress の翻訳との互換性が向上。
  • 細かな手入れ。
  • WordPress 4.4との互換性を確認。

1.0.3 (2014-12-18)

  • 追加: WordPress ネイティブ・ショートコード playlist についてのより詳細な情報。
  • WordPress 4.1との互換性を確認。

1.0.2 (2014-09-05)

  • プラグイン Plugin Dependencies との互換性を修正。
  • WordPress 4.0との互換性を確認。

1.0.1 (2014-04-19)

  • 修正: 投稿コンテンツ内のショートコードの検索を改善。
  • 修正: マイナーな HTML エラー。
  • 修正: マイナーな PHP エラー。

1.0 (2013-12-22)

  • 最初のリリース。