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ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

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

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

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

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

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

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

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

: CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る

他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。

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

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

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

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

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。