baserCMS公式ガイド「ver4/関数リファレンス/BcBaser getTitle」の版間の差分
提供: baserCMS公式ガイド
(description追加) |
|||
| (3人の利用者による、間の5版が非表示) | |||
| 行2: | 行2: | ||
## 説明 | ## 説明 | ||
| − | タイトルタグを取得する。 | + | タイトルタグを取得する。<br> |
| − | + | ||
ページタイトルと直属のカテゴリ名が同じ場合は、ページ名を省略します。 | ページタイトルと直属のカテゴリ名が同じ場合は、ページ名を省略します。 | ||
## 使い方 | ## 使い方 | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| − | $this->BcBaser->getTitle( [$separator] , [$ | + | <?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)の書式で指定。（初期値 = （空）） | ||
| + | |||
## 戻り値 | ## 戻り値 | ||
(string) | (string) | ||
| − | : | + | : メタタグ用のタイトル |
## 用例 | ## 用例 | ||
### 基本 | ### 基本 | ||
| + | タイトルタグを取得し、echoで出力する。 | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| − | <?php $this->BcBaser->getTitle(); ?> | + | <?php echo $this->BcBaser->getTitle(); ?> |
</syntaxhighlight> | </syntaxhighlight> | ||
####取得 | ####取得 | ||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
| − | コンテンツタイトル | | + | コンテンツタイトル | カテゴリ| サイト名 |
</syntaxhighlight> | </syntaxhighlight> | ||
### 応用 | ### 応用 | ||
| + | タイトルタグを取得し（/ 区切り、カテゴリを表示しない）、echoで出力する。 | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
| − | <?php $this->BcBaser->getTitle('/', false); ?> | + | <?php echo $this->BcBaser->getTitle('/', false); ?> |
</syntaxhighlight> | </syntaxhighlight> | ||
####取得 | ####取得 | ||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
| − | コンテンツタイトル / | + | コンテンツタイトル / サイト名 |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
##類似の関数 | ##類似の関数 | ||
| − | [ | + | - [getContentsTitle](/ver4/関数リファレンス/getContentsTitle) - コンテンツタイトルを取得する |
| − | + | - [contentsTitle](/ver4/関数リファレンス/contentsTitle) - コンテンツのタイトルを出力する | |
| − | [ | + | - [title](/ver4/関数リファレンス/title) - タイトルタグを出力する |
2018年12月13日 (木) 00:58時点における最新版
説明
タイトルタグを取得する。
ページタイトルと直属のカテゴリ名が同じ場合は、ページ名を省略します。
使い方
<?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 - タイトルタグを出力する
