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



お勧め

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。