_WP_Editors::parse_settings( string $editor_id, array $settings ): array

Parameters

$editor_idstring

HTML ID for the textarea and TinyMCE and Quicktags instances. Should not contain square brackets.

$settingsarray

Array of editor arguments.

• $wpautopbooldefault: true

  Whether to use wpautop().

• $media_buttonsbool

  Whether to show the Add Media/other media buttons.

• $default_editorstringdefault: empty

  When both TinyMCE and Quicktags are used, set which editor is shown on page load.

• $drag_drop_uploadbooldefault: false. Requires the media modal

  Whether to enable drag & drop on the editor uploading.

• $textarea_namestringdefault: $editor_id

  Give the textarea a unique name here. Square brackets can be used here.

• $textarea_rowsintdefault: 20

  Number rows in the editor textarea.

• $tabindexstring|intdefault: empty

  Tabindex value to use.

• $tabfocus_elementsstringdefault: ':prev,:next'

  The previous and next element ID to move the focus to when pressing the Tab key in TinyMCE.

• $editor_cssstringdefault: empty

  Intended for extra styles for both Visual and Code editors. Should include <style> tags, and can use "scoped".

• $editor_classstringdefault: empty

  Extra classes to add to the editor textarea element.

• $teenybooldefault: false

  Whether to output the minimal editor config. Examples include Press This and the Comment editor.

• $dfwbool

  Deprecated in 4.1. Unused.

• $tinymcebool|arraydefault: true

  Whether to load TinyMCE. Can be used to pass settings directly to TinyMCE using an array.

• $quicktagsbool|arraydefault: true

  Whether to load Quicktags. Can be used to pass settings directly to Quicktags using an array.

Return

array

Parsed arguments array.

Hooks fired · 1

One hook fires while _WP_Editors::parse_settings() runs, in this order:

1. 1
   apply_filters( wp_editor_settings )filterline 83 (+13 into the body)

   Filters the wp_editor() settings.

Uses · 7

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_parse_args()Merges user defined arguments into defaults array.
• has_blocks()Determines whether a post or content string has blocks.
• user_can_richedit()Determines whether the user can access the visual editor.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• get_user_setting()Retrieves user interface setting value based on setting name.

Used by · 2

• _WP_Editors::editor()Outputs the HTML for a single instance of the editor.
• wp_tiny_mce()Outputs the TinyMCE editor.

Source

View on Trac ↗View on GitHub ↗

70	public static function parse_settings( $editor_id, $settings ) {71 72		/**73		 * Filters the wp_editor() settings.74		 *75		 * @since 4.0.076		 *77		 * @see _WP_Editors::parse_settings()78		 *79		 * @param array  $settings  Array of editor arguments.80		 * @param string $editor_id Unique editor identifier, e.g. 'content'. Accepts 'classic-block'81		 *                          when called from block editor's Classic block.82		 */83		$settings = apply_filters( 'wp_editor_settings', $settings, $editor_id );84 85		$set = wp_parse_args(86			$settings,87			array(88				// Disable autop if the current post has blocks in it.89				'wpautop'             => ! has_blocks(),90				'media_buttons'       => true,91				'default_editor'      => '',92				'drag_drop_upload'    => false,93				'textarea_name'       => $editor_id,94				'textarea_rows'       => 20,95				'tabindex'            => '',96				'tabfocus_elements'   => ':prev,:next',97				'editor_css'          => '',98				'editor_class'        => '',99				'teeny'               => false,100				'_content_editor_dfw' => false,101				'tinymce'             => true,102				'quicktags'           => true,103			)104		);105 106		self::$this_tinymce = ( $set['tinymce'] && user_can_richedit() );107 108		if ( self::$this_tinymce ) {109			if ( str_contains( $editor_id, '[' ) ) {110				self::$this_tinymce = false;111				_deprecated_argument( 'wp_editor()', '3.9.0', 'TinyMCE editor IDs cannot have brackets.' );112			}113		}114 115		self::$this_quicktags = (bool) $set['quicktags'];116 117		if ( self::$this_tinymce ) {118			self::$has_tinymce = true;119		}120 121		if ( self::$this_quicktags ) {122			self::$has_quicktags = true;123		}124 125		if ( empty( $set['editor_height'] ) ) {126			return $set;127		}128 129		if ( 'content' === $editor_id && empty( $set['tinymce']['wp_autoresize_on'] ) ) {130			// A cookie (set when a user resizes the editor) overrides the height.131			$cookie = (int) get_user_setting( 'ed_size' );132 133			if ( $cookie ) {134				$set['editor_height'] = $cookie;135			}136		}137 138		if ( $set['editor_height'] < 50 ) {139			$set['editor_height'] = 50;140		} elseif ( $set['editor_height'] > 5000 ) {141			$set['editor_height'] = 5000;142		}143 144		return $set;145	}

History

Introduced in 3.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-editor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.