usces_the_itemImageCaption / 表示系関数

商品画像のキャプションを取得・表示する

説明

商品画像のキャプションを取得・表示します。
キャプションを表示するには、メディアでキャプションを登録する必要があります。

使い方

<?php usces_the_itemImageCaption(); ?>
<?php usces_the_itemImageCaption( $number, $post, $out ); ?>

パラメータ

$number
(数値)商品画像のインデックスを指定する。0 がメイン画像で、1 以降はサブ画像。
初期値は 0(メイン画像)。
$post
object)(オプション)投稿情報。初期値は NULL
未設定の場合は global $post が適用される。
$out
(文字列)戻り値の出力を echo するか return するかを決める。初期値は空文字(echo)。

  • ‘return’:return する
  • ”(空文字)もしくは未設定:echo する(初期値)

戻り値

(HTML)画像のキャプション
  • ‘return’:そのまま return
  • ”(空文字)もしくは未設定:echo

注意

キャプションを表示するには、メディアでキャプションを登録する必要があります。

用例

<div><?php usces_the_itemImage( 0, 135, 135 ); ?></div>
<div><?php usces_the_itemImageCaption( 0 ); ?></div>

フック

  • 利用できるフックはありません。

ソースファイル

usc-e-shop/functions/template_func.php

関連資料