img_caption_shortcode

説明

string img_caption_shortcode( array $attr [ , string $content = null ] )
キャプション付き画像のHTMLテキストを生成する(投稿記事に添付画像を挿入する場合に使用されているの実態関数)。

パラメータ

  • $attr
    属性値の連想配列。
    属性名意味値の例
    iddivタグまたはfigureタグのIDattachment-1234
    caption_id[5.1.0]pタグまたはfigcaptionタグのIDcaption-1234
    align配置指定(alignnone、alignleft、aligncenter、alignright)alignnone
    width画像幅300
    captionキャプションテキスト
  • $content
    画像のHTMLテキスト(省略時はnull)。

返り値

キャプション付き画像のHTMLテキストを返す。

注意

生成されるHTMLテキストは次のような構造になる(なおパラメータ$contentの内容は、HTMLタイプ(HTMLかXHTML)に応じて整形される)。

<div id="$attrのid値" class="wp-caption $attrのalign値" style="width: $attrのwidth値に10を加えた値;">$contentの内容<p id="$attrのcaption_id値" class="wp-caption-text">$attrのcaption値</p></div>

テーマのcaptionが'html5'に対応している場合はdivタグではなくfigureタグが適用される。

<figure id="$attrのid値" class="wp-caption $attrのalign値" style="width: $attrのwidth値;">$contentの内容<figcaption id="$attrのcaption_id値" class="wp-caption-text">$attrのcaption値</figcaption></figure>

[5.1.0]ショートコードの属性値に'caption_id'が追加された。


使用例

  • 直接本関数を呼んでキャプション付き画像のHTMLテキストを生成する。
    <?php 
    echo img_caption_shortcode( 
    	array(
    		'id'=>'attachment-1234', 
    		'caption_id'=>'caption-1234',
    		'align'=>'alignnone', 
    		'width'=>300, 
    		'caption'=>'ここにキャプション'
    	), 
    	'<a href="http://localhost/wp-content/uploads/image100.jpg"><img src="http://localhost/wp-content/uploads/image100-300x200.jpg" alt="ここに代替テキスト" title="ここにタイトル" width="300" height="200" class="size-medium wp-image-1234" /></a>' ); 
    ?>
    上記の場合に生成されるHTMLテキストは次の通り。
    <div id="attachment-1234" class="wp-caption alignnone" style="width: 310px">
    <a href="http://localhost/wp-content/uploads/image100.jpg">
    <img src="http://localhost/wp-content/uploads/image100-300x200.jpg" alt="ここに代替テキスト" title="ここにタイトル" width="300" height="200" class="size-medium wp-image-1234">
    </a>
    <p id="caption-1234" class="wp-caption-text">ここにキャプション</p>
    </div>
    ※ここでは便宜上改行しているが、実際に取得できるHTMLテキストは改行していない。

フィルター

[2.6.0]本関数でHTMLを生成する前に'img_caption_shortcode'フィルターを呼び出す。パラメータ$outputには''が、$attr$contentにはサニタイズ処理済みの内容が格納されている。
$output = apply_filters( 'img_caption_shortcode', $output, $attr, $content );
[3.7.0]HTMLを生成する前に'img_caption_shortcode_width'フィルターを呼び出す。パラメータ$widthには幅のpx値が、$attsにはショートコードの属性値の連想配列が、$contentにはサニタイズ処理済みの内容が格納されている。
$caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/media.php

最終更新 : 2019年03月04日 11:45



お勧め

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。