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.

Show class?             Show args?        

Common

NameReturnSummary 
InputfieldCKEditor::addExtraPluginsDir(string $dir)
(nothing)Add an extra plugins dir available to all CKEditor instances 
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::getConfigInputfields()
InputfieldWrapperConfigure Inputfield
InputfieldCKEditor::imageFields array 
InputfieldCKEditor::inheritField string Field to inherit above settings from 
InputfieldCKEditor::inlineMode bool int (default=0) 
InputfieldCKEditor::processInput(WireInputData $input)
$thisProcess data submitted to a CKEditor field
InputfieldCKEditor::removeExtraPluginsDir(string $dir)
(nothing)Remove an extra plugins dir for all CKEditor instances 
InputfieldCKEditor::removePlugins string 
InputfieldCKEditor::render()
stringRender the output code for CKEditor
InputfieldCKEditor::renderReady()
boolRender ready 
InputfieldCKEditor::renderValue()
stringRender non-editable version of Inputfield
InputfieldCKEditor::set(string $key, mixed $value)
Inputfield InputfieldCKEditorSet 
InputfieldCKEditor::stylesSet string 
InputfieldCKEditor::toggles array 
InputfieldCKEditor::toolbar string 
InputfieldCKEditor::useACF bool int (default=1) 
InputfieldCKEditor::usePurifier bool int (default=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.236

Newest forum posts

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 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

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.