Home » Php » php – How to pass param from controller to layout in YII2

php – How to pass param from controller to layout in YII2

Posted by: admin April 23, 2020 Leave a comment


I want to send a parameter from controller to layout (i.e. main.php). But I am not able to get the param in main.php

I tried:

Controller Code:

$this->render('index',array('param' => $paramValue));

And this is how i was trying to get this in layout ie. main.php

  1. $this->param (as in yii 1)
  2. $param

But i am not able to get param value in layout. Can anyone tell me how to do this?

How to&Answers:

yii\base\View has special $params property.

For example it’s used for building breadcrumbs in default generated CRUD code templates with Gii.

You can set it like this before rendering:

use Yii;

Yii::$app->view->params['customParam'] = 'customValue';

Inside a controller you can set it like this:

$this->view->params['customParam'] = 'customValue';

Then it will be available in views (including main layout):

/* @var $this yii\web\View */

echo $this->params['customParam'];

You can also find it in official guide.


I would like to suggest you some steps for this problem.

  1. pass parameter to view file
  2. Set parameter to view parameter
  3. Check For parameter and If exist then use it.

    //in controller method
    $this->render("view-file-name",["paramName" => "some parameter"]);
    //in view file for eg: index.php
    //i'm passing paremeter sent form controller's action to view params.
    $this->params["paramFromViewFile"] = $paramName; //here $paramName is the parameter we sent from controller's method
    //access parameter sent from view file
    if($this->params && !empty($this->params["paramFromViewFile"]))
         echo $this->params["paramFromViewFile"];  


directly calling $param u should get the value, try

in controller declare a $param,
public $param = '';

then in the acction do

in layout
echo $this->param;


Thats because you are rendering index.php view, not the main.php one.

And $param this is how you get it in 1.1 version.

UPD: If you want a param in your main.php layout declare it in your Controller class, and then you will be able to get it $this->param this way.

UPD2: Looks like in 2.0 version you need to declare param in a yii\web\View class. And access it via Yii::$app->view->param.


In Yii2 you can access your controller object from a view using $this->context for example if in your controller you set a parameter like this:

public $title = 'My custom title';

Then in your layout you can read it like this:


It is explained in Yii documentation in section: Accessing Data in Views


I had a same problem, I resolve that in:

  1. In my Controller par exemple, I do that

    $this->view->params['typeUser'] = 'Internaut';

  2. in my View

    $this->params['typeUser'] or echo $this->params['typeUser']