baserCMS公式ガイド「ver4/関数リファレンス/BcBaser getTitle」の版間の差分
提供: baserCMS公式ガイド
Katokaisya (トーク | 投稿記録) |
|||
| 行8: | 行8: | ||
## 使い方 | ## 使い方 | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| − | $this->BcBaser->getTitle( $separator , [$options] ) | + | <?php $this->BcBaser->getTitle( [$separator] , [$options] ); ?> |
</syntaxhighlight> | </syntaxhighlight> | ||
## パラメータ | ## パラメータ | ||
（string）$separator | （string）$separator | ||
| − | : | + | : 階層の区切り文字を指定する。 |
| − | : | + | : - 初期値 = '｜' |
| − | + | (array) $options | |
| − | : | + | :`categoryTitleOn` : カテゴリを表示するかを boolean で指定。falseで表示しない。（初期値 = null） |
| − | + | :`tag` : タグが記述されていた場合、どのように扱うかを boolean で指定。trueでエンコードして出力、falseで除去する。（初期値 = true） | |
| − | + | :`allowableTags` : tagがfalseだった場合、**除去しないタグ**をPHPの[strip_tags](http://php.net/manual/ja/function.strip-tags.php)の書式で指定。（初期値 = （空）） | |
| − | + | ||
| − | + | ||
| − | + | ||
| 行31: | 行28: | ||
## 用例 | ## 用例 | ||
### 基本 | ### 基本 | ||
| + | タイトルタグを取得し、echoで出力する。 | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| 行38: | 行36: | ||
####取得 | ####取得 | ||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
| − | コンテンツタイトル | | + | コンテンツタイトル | カテゴリ| ページタイトル |
</syntaxhighlight> | </syntaxhighlight> | ||
### 応用 | ### 応用 | ||
| + | タイトルタグを取得し（/区切り、カテゴリを表示しない）、echoで出力する。 | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| 行51: | 行50: | ||
コンテンツタイトル / ページタイトル | コンテンツタイトル / ページタイトル | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
## 注 | ## 注 | ||
| 行62: | 行60: | ||
##類似の関数 | ##類似の関数 | ||
| − | [ | + | - [getContentsTitle](/ver4/関数リファレンス/getContentsTitle) - コンテンツタイトルを取得する |
| + | - [contentsTitle](/ver4/関数リファレンス/contentsTitle) - コンテンツのタイトルを出力する | ||
| + | - [title](/ver4/関数リファレンス/title) - タイトルタグを出力する | ||
[[Category:関数リファレンスver4]] | [[Category:関数リファレンスver4]] | ||
2018年11月21日 (水) 23:48時点における版
目次
説明
タイトルタグを取得する。
ページタイトルと直属のカテゴリ名が同じ場合は、ページ名を省略します。
使い方
<?php $this->BcBaser->getTitle( [$separator] , [$options] ); ?>
パラメータ
- （string）$separator
- 階層の区切り文字を指定する。
- - 初期値 = '｜'
(array) $options
categoryTitleOn: カテゴリを表示するかを boolean で指定。falseで表示しない。（初期値 = null）tag: タグが記述されていた場合、どのように扱うかを boolean で指定。trueでエンコードして出力、falseで除去する。（初期値 = true）allowableTags: tagがfalseだった場合、除去しないタグをPHPのstrip_tagsの書式で指定。（初期値 = （空））
戻り値
- (string)
- メタタグ用のタイトルを返す
用例
基本
タイトルタグを取得し、echoで出力する。
コード
<?php echo $this->BcBaser->getTitle(); ?>
取得
コンテンツタイトル | カテゴリ| ページタイトル
応用
タイトルタグを取得し（/区切り、カテゴリを表示しない）、echoで出力する。
コード
<?php echo $this->BcBaser->getTitle('/', false); ?>
取得
コンテンツタイトル / ページタイトル
注
変更履歴
ソースファイル
関連資料
類似の関数
- getContentsTitle - コンテンツタイトルを取得する
- contentsTitle - コンテンツのタイトルを出力する
- title - タイトルタグを出力する
