wp_default_editor(): string

In this article

Finds out which editor should be displayed by default.

Description

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

Return

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

Source

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' ), true ) ) ? $ed : $r;
	}

	/**
	 * Filters which editor should be displayed by default.
	 *
	 * @since 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 );
}

Hooks

apply_filters( ‘wp_default_editor’, string $r )

Filters which editor should be displayed by default.

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.