img_caption_shortcode

パラメータ

• $attr
  属性値の連想配列。

  属性名	意味	値の例
  id	divタグまたはfigureタグのID	attachment-1234
  caption_id	[5.1.0]pタグまたはfigcaptionタグのID	caption-1234
  align	配置指定（alignnone、alignleft、aligncenter、alignright）	alignnone
  width	画像幅	300
  caption	キャプションテキスト

• $content
  画像のHTMLテキスト（省略時はnull''）。

返り値

注意

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

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

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

[5.9.0]パラメータ$contentが省略された場合、nullから''に変更された。

使用例

• 直接本関数を呼んでキャプション付き画像の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テキストは改行していない。

フィルター

$output = apply_filters( 'img_caption_shortcode', $output, $attr, $content );

$caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content );

アクション

ソースファイル