Improve this Doc


Installing composer is quick and simple.


  • CakePHP 3.x
  • PHP 5.4

Getting the source code

You can get the Crud source code using either composer or git.

Using composer

The recommended installation method for this plugin is by using composer.

Using the inline require for composer:

composer require friendsofcake/crud:~4.0

Or add this to your composer.json configuration:

        "require" : {
                "FriendsOfCake/crud": "~4.0"

Using git submodule

Or add it as a git module, this is recommended over git clone since it’s easier to keep up to date with development that way:

git submodule add git:// Plugin/Crud
cd Plugin/Crud

Loading the plugin

Add the following to your /App/Config/bootstrap.php


Configuring the controller

In your AppController add the following code:

namespace App\Controller;

class AppController extends \Cake\Controller\Controller {

        use \Crud\Controller\ControllerTrait;



It’s not required to add the ControllerTrait to AppController - you can add it to any specific controller as well if you don’t want Crud installed application wide

Adding the ControllerTrait itself do not enable anything CRUD, but simply installs the code to handle the \Cake\Error\MissingActionException exception so you don’t have to implement an action in your controller for Crud to work. This will make a lot of sense later.

The Configuration page explains how to setup and configure the Crud component.