img_caption_shortcode

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

説明

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

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

パラメータ

$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テキストを返す。

注意

生成される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'が追加された。

[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テキストは改行していない。

フィルター

[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

最終更新 : 2022年01月27日 16:10

参考

Code Reference: img_caption_shortcode

お勧め

Contact Form 7に確認フェーズを（2012年12月16日更新）

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

投稿一覧に独自リンクを追加する（2013年10月16日更新）

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

HTML編集モードに定型文ボタンを追加する（2011年6月1日更新）

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

投稿日の検索が自由自在に（2015年3月7日更新）

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろん query_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

プラグインのヘッダー情報を国際化対応しよう（2018年5月27日更新）

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧め