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のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。

: CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法

CakePHP4でコマンドを実行する際に引数（パラメータ）をコマンド内で受け取る処理について解説。複数個の引数にも対応する記述方法も解説。

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。

: CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。

: CakePHP4、5のユーザ認証でID、PASS以外の削除フラグなども条件加える方法

CakePHP4系、5系ではAuthenticationを使用してログイン認証を行う。その認証でID、PASS以外の削除フラグなどの条件を加えたいときの対応方法について解説。

: CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法

CakePHP4のクリエビルダーを使って複数のOR条件をANDでつなぐSQL文を作成する方法を解説。OR条件を記述したwhere句を2つつなげて記述する。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。