wp_default_editor()

Find out which editor should be displayed by default.

Description

Works out which of the two editors to display as the current editor for a user. The ‘html’ setting is for the "Text" editor tab.

Return

(string) Either 'tinymce', or 'html', or 'test'

Source

File: wp-includes/general-template.php

function wp_default_editor() {
	$r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
	if ( wp_get_current_user() ) { // look for cookie
		$ed = get_user_setting('editor', 'tinymce');
		$r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
	}

	/**
	 * Filters which editor should be displayed by default.
	 *
	 * @since WP-2.5.0
	 *
	 * @param string $r Which editor should be displayed by default. Either 'tinymce', 'html', or 'test'.
	 */
	return apply_filters( 'wp_default_editor', $r );
}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/general-template.php: user_can_richedit()	Whether the user can access the visual editor.
wp-includes/general-template.php: wp_default_editor	Filters which editor should be displayed by default.
wp-includes/pluggable.php: wp_get_current_user()	Retrieve the current user object.
wp-includes/plugin.php: apply_filters()	Call the functions added to a filter hook.
wp-includes/option.php: get_user_setting()	Retrieve user interface setting value based on setting name.

Used By

Used By
Used By	Description
wp-includes/class-wp-editor.php: _WP_Editors::editor()	Outputs the HTML for a single instance of the editor.

Changelog

Changelog
Version	Description
WP-2.5.0	Introduced.