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でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系のログイン認証の可否のチェック、および、ログインユーザの情報を取得する方法のまとめ。複数の方法があるが手続きが微妙に異なるためまとめてみた。

: CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。

: CakePHP5でヘルパーから他のヘルパーを読み込む方法・CakePHP4からの変更点

CakePHP5のヘルパーで他のヘルパーを読み込む方法を解説。公式の日本語CookbookはCakePHP4のソースのままで間違っているため注意が必要。CakePHP4からの移行の際も同じ点に注意が必要。