CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

2017/01/15 2019/09/28

CakePHP3でテンプレート、レイアウトのファイルを指定する方法

CakePHP3でテンプレートファイル（ctpファイル）を指定する方法

　
CakePHP3では、テンプレートファイル（ctpファイル）を指定しない場合は、デフォルト設定である現在のアクションと同じ名称のテンプレートファイルが読み込まれます。
　
例えば、「index」というアクションの場合は、「index.ctp」ファイルが読み込まれます。
　
ですが、アクション名と違うテンプレート名のファイルを利用したい場合や、レイアウトを変更したい場合は、テンプレートファイル名、レイアウト名を指定する必要があります。
　
具体的には以下のようになります。
　

    public function index ( ) {
          ：
          ：
        $this->set(compact('name'));
        $this->set('_serialize', ['name']);
        $this -> render ( "find", "admin" );
    }

public function index ( ) {

：

$this->set(compact('name'));

$this->set('_serialize', ['name']);

$this -> render ( "find", "admin" );

}

　
「$this -> render ( "find", "admin" );」のような記述を追加します。追加する場所は、処理の一番最後辺りがいいでしょう。
1つ目の引数がテンプレートファイル、2つ目の引数がレイアウトファイルになります。
　
記述するのは、ファイル名が「find.ctp」の場合は、「.ctp」を付けずに「find」のみを記述します。
　
　
記述する場所は、controllerの function内であれば問題ありませんので、一番最後に書いておくといいでしょう。
　
また、テンプレートファイルはそのままに、レイアウトファイルだけ変更したい場合は、「$this -> render ( null, "admin" );」のように、テンプレートファイルに「null」を指定します。
　
　
この記述方法は、CakePHP2の頃から変更がありません！
　
　

CakePHP3でテンプレート、レイアウトのファイルを使用しない場合の設定

　
上記は、テンプレート（View）や、レイアウトのファイルを指定する方法を説明しましたが、テンプレート（View）やレイアウトファイルを使用しないページもあるかと思います。
　
そのようなページで、テンプレート（View）やレイアウトファイルを使用しない設定の方法を解説します。
　
　

// レイアウト、テンプレート（View）の両方を無効にする場合
		$this->render(false,false);
		// もしくは
		$this->layout = false;
		$this->autoRender = false;

// レイアウトだけ無効にする場合
		$this->render(null,false);
		// もしくは
		$this->layout = false;

// テンプレート（View）ファイルだけ無効にする場合
		$this->render(false);
		// もしくは
		$this->render(false,null);
		// もしくは
		$this->autoRender = false;

// レイアウト、テンプレート（View）の両方を無効にする場合

$this->render(false,false);

// もしくは

$this->layout = false;

$this->autoRender = false;

// レイアウトだけ無効にする場合

$this->render(null,false);

// もしくは

$this->layout = false;

// テンプレート（View）ファイルだけ無効にする場合

$this->render(false);

// もしくは

$this->render(false,null);

// もしくは

$this->autoRender = false;

　
ちなみに、「false」を指定しているところに「""」を記述すると、エラーになる箇所とならない個所がありました。
　
　

Ajaxでテンプレートを呼び出すときの注意点　2019.09.28 追記

　
レイアウトだけ無効にする方法として解説をしている、上記の
「$this->render(null,false);」
という記述方法は、正しく動作しない場合があるようです。
　
例えば、Ajaxの処理でレイアウトは必要なく、テンプレートのみ必要な場合は、
「$this->render(null,false);」
とすると、コントローラーからの変数の受け渡しがうまく行かないようです。
　
そのような場合は、
「$this->layout = false;」
の方を試してみてください。
　
　

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

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

Message コメントをキャンセル

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

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

: CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。

: CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

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

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

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説

CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン（エレメント化、ブロック化）にして解説。

: CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

: CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説

CakePHP4のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。