Skip to content

Commit 9a7f511

Browse files
authored
Merge pull request #1006 from cakephp/plugins-config
Update notes for plugins config array.
2 parents 501ae31 + eb27132 commit 9a7f511

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

config/plugins.php

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,18 @@
1919
* @license https://opensource.org/licenses/mit-license.php MIT License
2020
*/
2121

22+
/*
23+
* List of plugins to load in the form `PluginName` => `[configuration options]`.
24+
*
25+
* Available options:
26+
* - onlyDebug: Load the plugin only in debug mode. Default false.
27+
* - onlyCli: Load the plugin only in CLI mode. Default false.
28+
* - optional: Do not throw an exception if the plugin is not found. Default false.
29+
*/
2230
return [
23-
// Plugins only needed when in debug mode
2431
'DebugKit' => ['onlyDebug' => true],
25-
26-
// Optional plugins which are only needed in CLI commands
2732
'Bake' => ['onlyCli' => true, 'optional' => true],
28-
29-
// Required plugins only in CLI commands
3033
'Migrations' => ['onlyCli' => true],
3134

32-
// Add your custom plugins here
35+
// Additional plugins here
3336
];

0 commit comments

Comments
 (0)