img_caption_shortcode：WordPress私的マニュアル

img_caption_shortcode

(2.6.0以降)
img_caption_shortcode - キャプション付き画像のHTMLテキストを生成する

説明

string img_caption_shortcode( array $attr [ , string $content = null ] )

キャプション付き画像のHTMLテキストを生成する（投稿記事に添付画像を挿入する場合に使用されているの実態関数）。

パラメータ

$attr
属性値の連想配列。

属性名意味値の例

id divタグのID attachment_1234

align 配置指定（alignnone、alignleft、aligncenter、alignright） alignnone

width 画像幅 300

caption キャプションテキスト
$content
画像のHTMLテキスト（省略時はnull）。

属性名	意味	値の例
id	divタグのID	attachment_1234
align	配置指定（alignnone、alignleft、aligncenter、alignright）	alignnone
width	画像幅	300
caption	キャプションテキスト

返り値

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

注意

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

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

使用例

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

<?php 
echo img_caption_shortcode( 
	array(  'id'=>'attachment_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_12341" 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 class="wp-caption-text">ここにキャプション</p>
</div>

※ここでは便宜上改行しているが、実際に取得できるHTMLテキストは改行していません。

img_caption_shortcode

説明

パラメータ

返り値

注意

使用例

関連

お勧めコンテンツ