img_caption_shortcode

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

説明

string img_caption_shortcode( array $attr [ , string $content = null ] )
キャプション付き画像のHTMLテキストを生成する(投稿記事に添付画像を挿入する場合に使用されているの実態関数)。

パラメータ

  • $attr
    属性値の連想配列。
    属性名意味値の例
    iddivタグのIDattachment_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 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テキストは改行していません。

関連

お勧めコンテンツ

the_date関数で投稿日を確実に表示する(2011年12月20日 登録)

投稿記事の投稿日時を表示する際、the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 登録)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

スクリプトファイルのバージョンパラメータを変更する(2015年2月10日 登録)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

LevelとCapability(2011年4月14日 登録)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

Login rebuilder 2.3.0の新機能を紹介(2017年8月31日 登録)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

最終更新日時 : 2014-11-16 17:40