img_caption_shortcode

説明

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テキストは改行していません。

最終更新 : 2018年05月27日 10:53



お勧め

スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。