baserCMS公式ガイド「ver4/関数リファレンス/getBlogs」の版間の差分
提供: baserCMS公式ガイド
細 (1版 : 関数リファレンス→ver4) |
Katokaisya (トーク | 投稿記録) |
||
| 行6: | 行6: | ||
## 使い方 | ## 使い方 | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| − | $this->BcBaser->getBlogs(); | + | $this->BcBaser->getBlogs( $name , [$options] ); |
</syntaxhighlight> | </syntaxhighlight> | ||
## パラメータ | ## パラメータ | ||
| − | + | (string) $name | |
ブログアカウント名を指定するとそのブログのみの基本情報を返す。空指定(default)で、全てのブログの基本情報。<br> | ブログアカウント名を指定するとそのブログのみの基本情報を返す。空指定(default)で、全てのブログの基本情報。<br> | ||
| − | ex) 'news' （初期値 : | + | ex) 'news' （初期値 : ) |
| − | + | ||
| − | + | (array) $options オプション(初期値 :array())<br> | |
| − | ex) 'created DESC'（初期値 : 'id'） | + | - `sort` : データのソート順 取得出来るフィールドのどれかでソートができる ex) 'created DESC'（初期値 : 'id'）<br> |
| + | - `siteId` : サブサイトIDで絞り込む場合に指定する（初期値：0 | ||
## 戻り値 | ## 戻り値 | ||
2016年11月4日 (金) 17:47時点における版
[このコンテンツは内容調整中です]
目次
説明
ブログの基本情報（説明、設定、表示件数、コメント許可など）を全て取得する。
使い方
$this->BcBaser->getBlogs( $name , [$options] );
パラメータ
(string) $name
ブログアカウント名を指定するとそのブログのみの基本情報を返す。空指定(default)で、全てのブログの基本情報。
ex) 'news' （初期値 : )
(array) $options オプション(初期値 :array())
- sort : データのソート順 取得出来るフィールドのどれかでソートができる ex) 'created DESC'（初期値 : 'id'）
- siteId : サブサイトIDで絞り込む場合に指定する（初期値：0
戻り値
（array）サイト基本設定配列
用例
基本
コード
<?php var_dump($this->BcBaser->getBlogs()); ?>
出力
全ブログの情報が配列で出力される
応用
コード
（例）news ブログの場合
<?php var_dump($this->BcBaser->getBlogs('news')); ?>
出力
news ブログの情報が配列出力される
