「関数リファレンス/Blog getEyeCatch」の版間の差分
提供: baserCMS公式ガイド
(3人の利用者による、間の3版が非表示) | |||
行3: | 行3: | ||
アイキャッチ画像は、ブログ記事編集画面からアイキャッチ画像欄にて登録することができます。 | アイキャッチ画像は、ブログ記事編集画面からアイキャッチ画像欄にて登録することができます。 | ||
##使い方 | ##使い方 | ||
+ | <syntaxhighlight lang="php"> | ||
<?php $this->Blog->getEyeCatch($post, $options) ?> | <?php $this->Blog->getEyeCatch($post, $options) ?> | ||
+ | </syntaxhighlight> | ||
##パラメーター | ##パラメーター | ||
<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> | ||
行36: | 行40: | ||
###基本 | ###基本 | ||
####コード | ####コード | ||
− | <?php $this-Blog->getEyeCatch($post) ?> | + | <syntaxhighlight lang="php"> |
+ | <?php echo $this-Blog->getEyeCatch($post) ?> | ||
+ | </syntaxhighlight> | ||
####出力 | ####出力 | ||
+ | <syntaxhighlight lang="html4strict"> | ||
<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> | <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> | ||
+ | </syntaxhighlight> | ||
###応用 | ###応用 | ||
####コード | ####コード | ||
− | <?php $this->Blog->getEyeCatch($post, array('width'=>'200px','height'=>'200px', 'alt'=>'example', 'noimage'=>'common/noimage.png')); ?> | + | <syntaxhighlight lang="php"> |
+ | <?php echo $this->Blog->getEyeCatch($post, array('width'=>'200px','height'=>'200px', 'alt'=>'example', 'noimage'=>'common/noimage.png')); ?> | ||
+ | </syntaxhighlight> | ||
####出力 | ####出力 | ||
+ | <syntaxhighlight lang="html4strict"> | ||
<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> | <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> | ||
+ | </syntaxhighlight> | ||
##注 | ##注 | ||
##変更履歴 | ##変更履歴 | ||
行52: | 行64: | ||
##擬似の関数 | ##擬似の関数 | ||
[$this->Blog->eyeCatch()](http://wiki.basercms.net/%E9%96%A2%E6%95%B0%E3%83%AA%E3%83%95%E3%82%A1%E3%83%AC%E3%83%B3%E3%82%B9/eyeCatch) | [$this->Blog->eyeCatch()](http://wiki.basercms.net/%E9%96%A2%E6%95%B0%E3%83%AA%E3%83%95%E3%82%A1%E3%83%AC%E3%83%B3%E3%82%B9/eyeCatch) | ||
+ | [[Category:関数リファレンス]] |
2016年3月30日 (水) 12:02時点における最新版
目次
説明
ブログテンプレート内に記述することで、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>