InputfieldCKEditor class

CKEditor textarea rich text editor.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldCKEditor class also inherits all the methods and properties of: InputfieldTextarea, InputfieldText, Inputfield, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
InputfieldCKEditor::addExtraPluginsDir() InputfieldCKEditor::addExtraPluginsDir(string $dir) InputfieldCKEditor::addExtraPluginsDir(string $dir)	None	Add an extra plugins dir available to all CKEditor instances
InputfieldCKEditor::getConfigInputfields() InputfieldCKEditor::getConfigInputfields() InputfieldCKEditor::getConfigInputfields()	None
InputfieldCKEditor::processInput() InputfieldCKEditor::processInput(WireInputData $input) InputfieldCKEditor::processInput(WireInputData $input)	`$this`	Process data submitted to a CKEditor field
InputfieldCKEditor::removeExtraPluginsDir() InputfieldCKEditor::removeExtraPluginsDir(string $dir) InputfieldCKEditor::removeExtraPluginsDir(string $dir)	None	Remove an extra plugins dir for all CKEditor instances
InputfieldCKEditor::render() InputfieldCKEditor::render() InputfieldCKEditor::render()	`string`	Render the output code for CKEditor
InputfieldCKEditor::renderReady() InputfieldCKEditor::renderReady() InputfieldCKEditor::renderReady($parent = null, bool $renderValueMode = false)	`bool`	Render ready
InputfieldCKEditor::renderValue() InputfieldCKEditor::renderValue() InputfieldCKEditor::renderValue()	`string`	Render non-editable version of Inputfield
InputfieldCKEditor::set() InputfieldCKEditor::set(string $key, mixed $value) InputfieldCKEditor::set(string $key, mixed $value)	`Inputfield` `InputfieldCKEditor`	Set

Properties

Name	Return	Summary	Default
InputfieldCKEditor::assetPageID	`int`
InputfieldCKEditor::configName	`string`
InputfieldCKEditor::contentsCss	`string`
InputfieldCKEditor::contentsInlineCss	`string`
InputfieldCKEditor::customOptions	`string`
InputfieldCKEditor::extraAllowedContent	`string`
InputfieldCKEditor::extraPlugins	`string` `array`
InputfieldCKEditor::extraPluginsDirs	`array`	Extra plugins directories, see addExtraPluginsDir() method. 3.0.179+
InputfieldCKEditor::formatTags	`string`
InputfieldCKEditor::imageFields	`array`
InputfieldCKEditor::inheritField	`string`	Field to inherit above settings from
InputfieldCKEditor::inlineMode	`bool` `int`		`0`
InputfieldCKEditor::removePlugins	`string`
InputfieldCKEditor::stylesSet	`string`
InputfieldCKEditor::toggles	`array`
InputfieldCKEditor::toolbar	`string`
InputfieldCKEditor::useACF	`bool` `int`		`1`
InputfieldCKEditor::usePurifier	`bool` `int`		`0`

Additional methods and properties

In addition to the methods and properties above, InputfieldCKEditor also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251