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

お勧め

Emojin：プラグイン作ってみました（2015年3月21日更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧め