CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

2019/09/21

CakePHP3では metaタグを編集する HTMLヘルパーが用意されている

metaタグの keywords、DescriptionをHTMLヘルパーを使って設定する方法

　
CakePHP3で keywords、Descriptionを設定する方法を解説します。
　
CakePHP3には最初から metaタグを編集する HTMLヘルパーが組み込まれています。
それを利用してメタタグの keywords、Descriptionを編集します。
　
　

metaタグが編集されるレイアウトファイルを確認

　
まずはじめに、metaタグが編集される場所を確認します。
　
metaタグが編集されるファイルは、下記のレイアウトファイルになります。
/src/Template/Layout/default.ctp
　
このレイアウトファイルの 32行目あたりに「<?= $this->fetch(‘meta’) ?>」という記述があります。
これが metaタグを出力する「fetch()」になります。
　
ここに編集する値を、各ページごとのテンプレートで指定する、という処理になります。
　
　

metaタグの値を指定するテンプレートファイルを編集

　
値を指定するテンプレートは
/src/Template/Topics/view.ctp
などのテンプレートファイルに下記のコードを記述します。
　
　
記述する metaタグのヘルパーの基本形は以下のようになります。
　

<?= $this->Html->meta("属性","値",["block"=>true]); ?>

1	<?= $this->Html->meta("属性","値",["block"=>true]); ?>

　
　
具体的に「keywords」「description」を指定すると以下のようになります。
　

<?= $this->Html->meta("keywords","キーワード",["block"=>true]); ?>
<?= $this->Html->meta("description","ディスクリプション",["block"=>true]); ?>

1 2	<?= $this->Html->meta("keywords","キーワード",["block"=>true]); ?> <?= $this->Html->meta("description","ディスクリプション",["block"=>true]); ?>

　
1つ目のパラメーターが、metaタグの「name（属性）」の値を指定するもので「keywords」は「キーワード」、「description」は「ディスクリプション」を指定する箇所になります。
　
2つ目のパラメーターが、metaタグの「content」の値を指定する箇所になります。
　
　
出力結果は以下のようになります。
　

<meta name="keywords" content="キーワード"/>
<meta name="description" content="ディスクリプション"/>

1 2	<meta name="keywords" content="キーワード"/> <meta name="description" content="ディスクリプション"/>

　
　
また、3つ目のパラメーターは、ブロック化をするのか、しないのかを指定する箇所になります。
　
「ブロック化」のデフォルトは、「"block"=>false」の「ブロック化をしない」になっています。
そのため、デフォルトの設定では、metaタグが編集される場所がテンプレートファイルに「<?= $this->fetch(‘meta’) ?>」を記述した場所になります。
　
そのため、「<body>」と「</body>」の間に出力され、metaタグの役割を果たしません。
　
そのため、「"block"=>true」を記述し、headタグ内に記述してある「<?= $this->fetch(‘meta’) ?>」の場所にまとめて出力されるようにします。
　
これが、「ブロック化を有効にする」指定です。
　
基本的に metaタグを出力する処理は「"block"=>true」も記述する、という認識で問題ありません。
　
　
ちなみに、「"block"=>true」が指定されている場合は、echoがなくても metaタグに出力することができます。
　

// 出力される
$this->Html->meta("description","ディスクリプション",["block"=>true]);

// 出力される
echo $this->Html->meta("description","ディスクリプション");

// 出力されない
$this->Html->meta("description","ディスクリプション");

// 出力される

$this->Html->meta("description","ディスクリプション",["block"=>true]);

// 出力される

echo $this->Html->meta("description","ディスクリプション");

// 出力されない

$this->Html->meta("description","ディスクリプション");

サイト全体に共通する処理をページごとに切り替える処理

　
今回は、サイト全体に共通して指定をする必要はあるものの、ページごとにそれぞれ違うテキストを切り替えて編集していく必要がある metaタグの「keywords」「description」を指定する方法を解説しました。
　
　
同じような考え方をする仕組みとして、下記の記事で書いている titleタグ、h1タグの値を指定する方法や、使用する JavaScriptや CSSをページごとに設定する方法、パンくずを指定する方法、OGPを指定する方法などにも活用することができます。
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
 CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説
 CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
 CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
 CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
　
　
これらは、レイアウトファイルに変数を指定しておき、そこに編集する値を各ページ用のテンプレートファイルで指定する、という仕組みです。
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

: CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単！

: CakePHP 2.3　bakeの超初心者向けフォロー講座

CakePHP 2.3　bakeの超初心者向けフォロー講座

: CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

: CakePHP3のインストールでURL rewriting……のエラーが！その解決方法解説

CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。