InputfieldTinyMCE class

TinyMCE rich text editor version 6.8.2.

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

Common
Properties

Common

Name	Return	Summary
InputfieldTinyMCE::addPlugin() InputfieldTinyMCE::addPlugin(string $file) InputfieldTinyMCE::addPlugin(string $file)	None	Add an external plugin .js file
InputfieldTinyMCE::configurable() InputfieldTinyMCE::configurable() InputfieldTinyMCE::configurable(bool $set = null)	`bool`	Get or set configurable state
InputfieldTinyMCE::get() InputfieldTinyMCE::get($key) InputfieldTinyMCE::get($key)	`array` `mixed` `string` `null`	Get
InputfieldTinyMCE::getConfigInputfields() InputfieldTinyMCE::getConfigInputfields() InputfieldTinyMCE::getConfigInputfields()	`InputfieldWrapper`	Get Inputfield configuration settings
InputfieldTinyMCE::getConfigName() InputfieldTinyMCE::getConfigName() InputfieldTinyMCE::getConfigName()	`string`	Get configuration name used to store settings in ProcessWire.config JS
InputfieldTinyMCE::getDirectionality() InputfieldTinyMCE::getDirectionality() InputfieldTinyMCE::getDirectionality()	`string`	Get directionality, either 'ltr' or 'rtl'
InputfieldTinyMCE::getExtraStyles() InputfieldTinyMCE::getExtraStyles() InputfieldTinyMCE::getExtraStyles()	`string`	Get styles to add in <head>
InputfieldTinyMCE::getModuleConfigInputfields() InputfieldTinyMCE::getModuleConfigInputfields(InputfieldWrapper $inputfields) InputfieldTinyMCE::getModuleConfigInputfields(InputfieldWrapper $inputfields)	None
InputfieldTinyMCE::getSettingNames() InputfieldTinyMCE::getSettingNames($types) InputfieldTinyMCE::getSettingNames($types)	`string`	Get all configurable setting names
InputfieldTinyMCE::helper() InputfieldTinyMCE::helper(string $name) InputfieldTinyMCE::helper(string $name)	`InputfieldTinyMCEClass`	Get helper
InputfieldTinyMCE::mcePath() InputfieldTinyMCE::mcePath() InputfieldTinyMCE::mcePath(bool $getUrl = false)	`string`	Return path or URL to TinyMCE files
InputfieldTinyMCE::processInput() InputfieldTinyMCE::processInput(WireInputData $input) InputfieldTinyMCE::processInput(WireInputData $input)	`$this`	Process input
InputfieldTinyMCE::removePlugin() InputfieldTinyMCE::removePlugin(string $file) InputfieldTinyMCE::removePlugin(string $file)	`bool`	Remove an external plugin .js file
InputfieldTinyMCE::render() InputfieldTinyMCE::render() InputfieldTinyMCE::render()	`string`	Render Inputfield
InputfieldTinyMCE::renderReady() InputfieldTinyMCE::renderReady() InputfieldTinyMCE::renderReady($parent = null, bool $renderValueMode = false)	`bool`	Render ready
InputfieldTinyMCE::renderValue() InputfieldTinyMCE::renderValue() InputfieldTinyMCE::renderValue()	`string`	Render non-editable value
InputfieldTinyMCE::set() InputfieldTinyMCE::set($key, $value) InputfieldTinyMCE::set($key, $value)	`self`	Set
InputfieldTinyMCE::setConfigName() InputfieldTinyMCE::setConfigName(string $configName) InputfieldTinyMCE::setConfigName(string $configName)	`$this`	Set configuration name used to store settings in ProcessWire.config JS
InputfieldTinyMCE::useFeature() InputfieldTinyMCE::useFeature(string $name) InputfieldTinyMCE::useFeature(string $name)	`bool`	Use the named feature?

Properties

Name	Return	Summary
InputfieldTinyMCE::configName	`string`	Name of configuration set to use DEFAULT: blank
InputfieldTinyMCE::content_css	`string`	Basename of content CSS file to use or "custom" to use custom URL DEFAULT: wire
InputfieldTinyMCE::content_css_url	`string`	Applies only if $content_css has value "custom"
InputfieldTinyMCE::contextmenu	`string`	Space-separated string of tools to show in context menu
InputfieldTinyMCE::debugMode	`bool` `int`	Makes InputfieldTinyMCE.js use verbose console.log() messages DEFAULT: false
InputfieldTinyMCE::defaultsFile	`string`	Location of optional defaults.json file that merges with defaults.json (URL relative to PW root URL)
InputfieldTinyMCE::defaultsJSON	`string`	JSON that merges with the defaults.json for all instances
InputfieldTinyMCE::extPluginOpts	`string`	Newline separated URL paths (relative to PW root) of extra plugin .js files
InputfieldTinyMCE::extPlugins	`array`	Additional plugins to enable for this field (URL paths from customPluginOptions)
InputfieldTinyMCE::external_plugins	`array`	URLs of external plugins, this is also a TinyMCE setting
InputfieldTinyMCE::extraCSS	`string`	Extra CSS for editor, applies to all editors (appended to TinyMCE content_style setting)
InputfieldTinyMCE::features	`array`	General features: toolbar, menubar, statusbar, stickybars, spellcheck, purifier, imgUpload, imgResize, pasteFilter
InputfieldTinyMCE::headlines	`array`	Allowed headline types
InputfieldTinyMCE::height	`int`	Height of editor in pixels
InputfieldTinyMCE::imageFields	`array`	Names of fields allowed for drag-drop in images
InputfieldTinyMCE::initialized	`bool`	Is the editor initialized? This is a read-only property. DEFAULT: false
InputfieldTinyMCE::inlineMode	`int`	Use inline mode? 0=Regular editor, 1=Inline editor, 2=Fixed height inline editor
InputfieldTinyMCE::invalid_styles	`string`	Space-separated string of invalid inline styles
InputfieldTinyMCE::lazyMode	`int`	Use lazy-loading mode? 0=Off, 1=Lazy, 2=Extra lazy
InputfieldTinyMCE::menubar	`string`	Space-separated list of top-level menubar items
InputfieldTinyMCE::optionals	`array`	Names of optional settings that can be configured per-field
InputfieldTinyMCE::pasteFilter	`string`	Rule string of elements and attributes allowed during filtered paste
InputfieldTinyMCE::plugins	`string`	Space-separated string of plugins to enable
InputfieldTinyMCE::readonly	`bool`	Are we in read-only mode? Automatically set during renderValue mode. This is a read-only property. DEFAULT: false
InputfieldTinyMCE::removed_menuitems	`string`	Space-separated string of tools to remove from menubar
InputfieldTinyMCE::settingsField	`string`	Alternate field to inherit settings from rather than configure settings with this instance.
InputfieldTinyMCE::settingsFile	`string`	Location of optional custom-settings.json settings file (URL relative to PW root URL)
InputfieldTinyMCE::settingsJSON	`string`	JSON with custom settings that override the defaults
InputfieldTinyMCE::skin	`string`	Skin to use DEFAULT: oxide
InputfieldTinyMCE::skin_url	`string`	URL to skin
InputfieldTinyMCE::styleFormatsCSS	`string`	Style formats as CSS to parse and apply to style_formats and content_style
InputfieldTinyMCE::toggles	`array`	Markup toggles, see self::toggle* constants
InputfieldTinyMCE::toolbar	`string`	Space-separated string of tools to show in toolbar

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251