InputfieldTinyMCE

TinyMCE settings are built from several layers. Later layers win:

1. Built-in defaults from defaults.json.
2. Module-level defaults from defaultsFile and defaultsJSON.
3. Per-field settingsFile and settingsJSON.
4. Field/UI settings such as toolbar, plugins, features, inlineMode, toggles, and headlines.
5. Runtime settings applied in renderReady(), such as disabling pasted data-images when no image field is available.

JSON override settings support prefixes:

$f->settingsJSON = json_encode([
    'replace_toolbar' => 'styles bold italic',
    'add_plugins' => 'wordcount',
]);

The string value default means "use the upstream default" for settings that support it.

TinyMCE Settings

Field/Inputfield Settings

Module Settings

Runtime Helpers

The features array is queried with useFeature($name).

if($f->useFeature('purifier')) {
    // HTML Purifier is enabled for this editor.
}

useFeature($name)

Return whether a named feature is enabled. Passing inline checks inlineMode > 0.

mcePath($getUrl = false)

Return the disk path to the bundled TinyMCE directory, or its URL when $getUrl is true.

$path = $f->mcePath();
$url = $f->mcePath(true);

setConfigName($name) / getConfigName()

Set or get the JavaScript settings key for this instance.

$f->setConfigName('body_compact');
echo $f->getConfigName();

configurable($set = null)

Get or set whether this field is independently configurable. A non-configurable field inherits settings from settingsField.

getSettingNames($types)

Return setting names for one or more setting groups: tinymce, field, module, or optionals.

$names = $f->getSettingNames('tinymce field');

Throws WireException for unknown groups.

addPlugin($file) / removePlugin($file)

Add or remove an external plugin .js file in module configuration. $file is relative to the ProcessWire root, such as /site/templates/mce/plugin.js. addPlugin() requires the file to exist.

getDirectionality()

Return ltr or rtl. The value is translatable with context language-direction.

renderReady($parent = null, $renderValueMode = false)

Load TinyMCE assets once per request, compute runtime settings, set configName, detect usable image fields, and prepare JavaScript settings.

render()

Render the editor. Classic mode renders a textarea plus init script. Inline mode renders a contenteditable div when HTML Purifier is available.

renderValue()

Render a sanitized non-editable value outside ProcessPageEdit, or defer to normal render behavior while ProcessPageEdit is rendering value mode.

processInput(WireInputData $input)

Process submitted markup, purify it when enabled, restore inline-mode field names after processing, and track value changes.

The helper objects are public for advanced use, but most sites should use the Inputfield properties and methods above.

Useful examples:

$defaults = $f->settings->getDefaults();
$parsed = $f->formats->invalidStylesStrToArray('color a=background|border');
$cssUrl = $f->settings->getContentCssUrl();

• Set a textarea field's inputfieldClass to InputfieldTinyMCE for normal field usage.
• The editor requires MarkupHTMLPurifier; ProcessWire declares this module as a requirement.
• toolbar values containing commas are ignored because they look like legacy CKEditor toolbar syntax.
• invalid_styles supports global styles like color and tag-specific styles like a=background|background-color or table|td=height.
• Image upload integration requires a real page editing context and an available multi-image FieldtypeImage field.
• External plugins configured with addPlugin() are stored in module config; selecting them for one field uses the extPlugins field setting.
• The bundled TinyMCE directory is tinymce-6.8.2/.

Source files: wire/modules/Inputfield/InputfieldTinyMCE/InputfieldTinyMCE.module.php and companion helper files in the same directory.