「関数リファレンス/Blog getEyeCatch」の版間の差分
提供: baserCMS公式ガイド
行8: | 行8: | ||
##パラメーター | ##パラメーター | ||
<dl> | <dl> | ||
− | <dt>$post</dt> | + | <dt>(array)$post</dt> |
<dd> | <dd> | ||
− | + | ブログ記事の連想配列 | |
必須 | 必須 | ||
</dd> | </dd> | ||
− | <dt>$options | + | <dt>(array)$options</dt> |
<dd> | <dd> | ||
− | + | img要素の属性等を任意で連想配列で指定 | |
*初期値 : array() | *初期値 : array() | ||
− | * | + | *`imgsize` : 画像サイズ[thumb|small|medium|large](初期値 : thumb) |
− | * | + | *`link` : 大きいサイズの画像へのリンク有無(初期値 : true) |
− | * | + | *`escape` : タイトルについてエスケープする場合に true を指定(初期値 : false) |
− | * | + | *`mobile` : モバイルの画像を表示する場合に true を指定(初期値 : false) |
− | * | + | *`alt` : alt属性(初期値 : "") |
− | * | + | *`width` : 横幅(初期値 : "") |
− | * | + | *`height` : 高さ(初期値 : "") |
− | * | + | *`noimage` : 画像が存在しない場合に表示する画像(初期値 : "") |
− | * | + | *`tmp` : 一時保存データの場合に true を指定(初期値 : false) |
+ | *`class` : タグの class を指定(初期値 : img-eye-catch) | ||
+ | *`force` : 画像が存在しない場合でも強制的に出力する場合に true を指定する(初期値 : false) | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
##戻り値 | ##戻り値 | ||
<dl> | <dl> | ||
− | <dt>( | + | <dt>(string)</dt> |
− | <dd> | + | <dd>アイキャッチ画像のHTML</dd> |
</dl> | </dl> | ||
行39: | 行41: | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
− | <?php $this-Blog->getEyeCatch($post) ?> | + | <?php echo $this-Blog->getEyeCatch($post) ?> |
</syntaxhighlight> | </syntaxhighlight> | ||
####出力 | ####出力 | ||
行49: | 行51: | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
− | <?php $this->Blog->getEyeCatch($post, array('width'=>'200px','height'=>'200px', 'alt'=>'example', 'noimage'=>'common/noimage.png')); ?> | + | <?php echo $this->Blog->getEyeCatch($post, array('width'=>'200px','height'=>'200px', 'alt'=>'example', 'noimage'=>'common/noimage.png')); ?> |
</syntaxhighlight> | </syntaxhighlight> | ||
####出力 | ####出力 |
2015年5月7日 (木) 04:03時点における版
目次
説明
ブログテンプレート内に記述することで、aタグで挟まれたimgタグ(アイキャッチ画像)の文字列を返します。
アイキャッチ画像は、ブログ記事編集画面からアイキャッチ画像欄にて登録することができます。
使い方
<?php $this->Blog->getEyeCatch($post, $options) ?>
パラメーター
- (array)$post
- ブログ記事の連想配列 必須
- (array)$options
-
img要素の属性等を任意で連想配列で指定
- 初期値 : array()
- `imgsize` : 画像サイズ[thumb|small|medium|large](初期値 : thumb)
- `link` : 大きいサイズの画像へのリンク有無(初期値 : true)
- `escape` : タイトルについてエスケープする場合に true を指定(初期値 : false)
- `mobile` : モバイルの画像を表示する場合に true を指定(初期値 : false)
- `alt` : alt属性(初期値 : "")
- `width` : 横幅(初期値 : "")
- `height` : 高さ(初期値 : "")
- `noimage` : 画像が存在しない場合に表示する画像(初期値 : "")
- `tmp` : 一時保存データの場合に true を指定(初期値 : false)
- `class` : タグの class を指定(初期値 : img-eye-catch)
- `force` : 画像が存在しない場合でも強制的に出力する場合に true を指定する(初期値 : false)
戻り値
- (string)
- アイキャッチ画像のHTML
用例
基本
コード
<?php echo $this-Blog->getEyeCatch($post) ?>
出力
<a href="/files/blog/news/blog_posts/2014/10/00000002_eye_catch.jpg?1562565448" class="img-eye-catch" rel="colorbox"><img src="/files/blog/news/blog_posts/2014/10/00000002_eye_catch__thumb.jpg?309076432" alt="example" width="200px" height="200px" /></a>
応用
コード
<?php echo $this->Blog->getEyeCatch($post, array('width'=>'200px','height'=>'200px', 'alt'=>'example', 'noimage'=>'common/noimage.png')); ?>
出力
<a href="/files/blog/news/blog_posts/2014/10/00000002_eye_catch.jpg?1060262106" class="img-eye-catch" rel="colorbox"><img src="/files/blog/news/blog_posts/2014/10/00000002_eye_catch__thumb.jpg?2011526910" alt="example" width="200px" height="200px" /></a>