baserCMS ver.5.x.x でもショートコードを使ってみた
baserCMS5 でも、記事本文や固定ページ本文の中でショートコードを使えます。
本文中に [] で記述するだけで、サイトマップやフォームなどを差し込めるので、コンテンツ編集の自由度が上がります。
公式サイト: https://basercms.net/
※ baserCMS 4系のショートコードの基本については、baserCMSのショートコード(1)基本 を参照してください。
この記事でやること
固定ページ本文にショートコードを記述し、サイトマップを表示するところまでを確認します。
想定読者
- baserCMS5 でサイトを構築している人
- テーマや設定ファイルを最低限触れる人
ショートコードとは
ショートコードは、本文内で baserCMS の機能を呼び出すための記法です。
例えば、固定ページの途中にサイトマップを差し込むときは、次のように記述します。
[BcBaser.getSitemap]
使い方(baserCMS5)
1. 設定ファイルを確認する
baserCMS5 では、設定ファイルは次の場所です。
ドキュメントルート/config/setting.php
2. 設定ファイルを記述する
BcShortCode の設定に、利用したいショートコードが含まれているか確認します。
(既存の return [ ... ] 配列に追記する形です)
'BcShortCode' => [
'BaserCore' => [
'BcBaser.getSitemap',
],
],
案件で使用しているテーマでも設定は可能です
ドキュメントルート/plugins/テーマ名/config/setting.php
を作成し、以下のように記述します。
<?php
/**
* setting
*
* plugins/baser-core/config/setting.php の値をカスタマイズする場合は、ここに定義する。
*/
return [
'BcShortCode' => [
'BaserCore' => [
'BcBaser.getSitemap',
],
],
];
3. 固定ページ本文にショートコードを書く
管理画面の固定ページ編集画面で、本文に次を記述して保存します。
[BcBaser.getSitemap]
4. 公開側で確認する
公開ページを表示すると、本文のその位置にサイトマップが展開されます。
補足
- 引数が必要な処理をショートコードで扱う場合は、記述が長くなりやすいです。
- よく使う出力は、呼び出し用のラッパーを用意しておくと運用しやすくなります。
- ショートコードの詳細については公式ガイドも参照してください。
- ショートコード自体は、baserCMS 4系のものも流用できますので、以下の記事も必要に応じて参考にしてください。
baserCMSのショートコード(2)小技
baserCMSのショートコード(3)応用(メールフォーム)