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.236

Latest news

  • ProcessWire Weekly #542
    In the 542nd issue of ProcessWire Weekly we'll check out a couple of new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 28 September 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer