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

お勧め

自動生成される抜粋からテーブルブロックの内容を除外する（2022年4月6日更新）

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton：プラグイン作ってみました（2012年12月24日更新）

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日更新）

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。

投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日更新）

WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。

さくらのVPSでKUSANAGI#2（2018年5月27日更新）

今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧め