セキュリティの予防措置として、WordPress コンテンツ内で PHP を実行することは禁止されています。コンテンツとの動的なインタラクションを可能にするために、WordPress バージョン2.5でショートコードが導入されました。
ショートコードは、コンテンツとの動的なインタラクション、たとえば、投稿に添付された画像からギャラリーを作成したり、ビデオをレンダリングする、等を実行するために使用できるマクロです。
なぜショートコードなのですか ?
ショートコードは、コンテンツをクリーンでセマンティックに保ちながら、コンテンツの表示をエンドユーザーがプログラムで変更できるようにする、便利な方法です。
エンドユーザーがショートコードを使用してフォトギャラリーを投稿に追加する場合、可能な限り最小限のデータを使用して、ギャラリーの表示方法を指示できます。
利点:
- 投稿コンテンツにマークアップが追加されないので、マークアップやスタイリングを、その場で、または後で、簡単に操作できます。
- ショートコードは、パラメータを受け取ることもでき、インスタンスごとにショートコードの動作をユーザーが変更できます。
組込みのショートコード
デフォルトでは、WordPress には以下のショートコードが用意されています:
[caption]– コンテンツのキャプションをラップ (回り込み) できます。[gallery]– 画像ギャラリーを表示できます。[audio]– 音声ファイルを埋め込んで再生できます。[video]– 動画ファイルを埋め込んで再生できます。[playlist]– オーディオファイルやビデオファイルのコレクションを表示できます。[embed]– 埋め込み項目をラップ (回り込み) できます。
ショートコードのベストプラクティス
ショートコード開発に関するベストプラクティスには、プラグイン開発のベストプラクティスと以下のリストがあります:
- 常に return を実行しましょう ! ショートコードは基本的にフィルターですので、「副作用」を作ると予期せぬバグにつながります。
- 他のプラグインとの衝突を避けるために、ショートコード名に接頭辞をつけましょう。
- 入力をサニタイズし、出力をエスケープしましょう。
- すべてのショートコード属性に関して明確なドキュメントをユーザーに提供しましょう。
クイック・リファレンス
基本的なショートコードの構造、自己完結型と囲み型シナリオの取り扱い、入れ子状態のショートコード、出力の安全確保を使用する完全な例を参照してください。