InputfieldCKEditor::addExtraPluginsDir() method

Add an extra plugins dir available to all CKEditor instances

Add an extra plugins dir, relative to ProcessWire installation root. An example could be /site/modules/MyModule/plugins/. Dir should have one or more directories within it having CKEditor plugins, which are identified by the presence of a plugin.js file in a directory, for example /site/modules/MyModule/plugins/foobar/plugin.js for a plugin named 'foobar'. Please note that the /foobar/ portion of the example directory would NOT be in the dir specified to this method.

Note the dir added from this method is saved to the CKEditor module configuration and thus is present for all future CKEditor instances, whether in this request or another. It will remain until removed by removeExtraPluginsDir().

Available since version 3.0.179.

Example

$f = $modules->get('InputfieldCKEditor');
$f->addExtraPluginsDir('/site/modules/MyModule/plugins/'); 

Usage

$inputfieldCKEditor->addExtraPluginsDir(string $dir);

Arguments

NameType(s)Description
dirstring

See Also


InputfieldCKEditor methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer