• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

ショートコード

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「ショートコード」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

WordPress バージョン 2.5 から ショートコード(Shortcodes)というものがサポートされました。これは投稿内容で使えるマクロを作るために導入されました。ショートコードの例と使い方については、WordPress.com Shortcodes を参照してください。ただしそこで紹介されているショートコードの一部は WordPress.com だけで使えるものです。

ギャラリー用のふつうのショートコードは次のようになります:

[gallery]

ショートコードには次の例のように属性を追加することもできます:

[gallery id="123" size="medium"]

どちらの例も画像ギャラリーを表示します。これを HTML マークアップで書いてアップロードされた画像と常に同期させるのは難しいものです。ショートコードを使えばギャラリー用のマークアップを動的かつ自動的に作ることができます。

WordPress はデフォルトでいくつかのショートコード(例えばギャラリー用)を提供しています。またプラグインは ショートコード API を使って自前のショートコードを追加できます。

以下のショートコードが WordPress にあります:

ショートコードのエスケープ

投稿の中でふつうはショートコードを表す文字列をただの文字列として使いたい場合があります。そうするには1組ではなく2組のかぎかっこを使ってショートコードをエスケープする必要があります。例えば次のように投稿内に表示するには:

[gallery]

次のように書きます:

[[gallery]]

開始タグと終了タグを持つショートコードの場合は、一番最初と一番最後のかぎかっこをエスケープする必要があります:

[[shortcode] ... [/shortcode]]

注意:現在利用できるショートコードだけがこの方法でエスケープできます。今はショートコードとして登録されていない文字列を二重のかぎかっこでくくっても、登録済みショートコードの場合とは違って、両方のかぎかっこがそのまま投稿に表示されます。

ウィジェット内でのショートコード

デフォルトでは、WordPress はサイドバーのウィジェット内でショートコードをサポートしません。投稿、固定ページ、カスタム投稿タイプの本文の中でのみショートコードを展開します。サイドバーのウィジェットにもショートコードをサポートさせるには、プラグインをインストールするか、以下のコードを使用します:

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

上記の行は、この順序で追加することが重要です。1行目は WordPress が改行を段落タグへ変換するのを止めさせます。そうすることでショートコードは正しく働きます。2行目は実際にショートコードを動作させます。

外部リソース

ショートコード: [audio] /en, [caption] /en, [embed] /en, [gallery] /en, [playlist] /en, [video] /en

最新英語版: WordPress Codex » Shortcode最新版との差分