_WP_Editors::editor( string $content, string $editor_id, array $settings = array() )

Parameters

$contentstring

Initial content for the editor.

$editor_idstring

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

$settingsarrayoptional

See _WP_Editors::parse_settings() for description.Default: array()

Hooks fired · 5

5 hooks fire while _WP_Editors::editor() runs, in this order:

1. 1
   do_action( media_buttons )actionline 240 (+81 into the body)

   Fires after the default media button(s) are displayed.

2. 2
   apply_filters( the_editor )filterline 267 (+108 into the body)

   Filters the HTML markup output that displays the editor.

3. 3
   apply_filters( the_editor_content )filterline 289 (+130 into the body)

   Filters the default editor content.

4. 4
   apply_filters( htmledit_pre )filterline 299 (+140 into the body)

   Filters the text before it is formatted for the HTML editor.

5. 5
   apply_filters( richedit_pre )filterline 302 (+143 into the body)

   Filters text returned for the rich text editor.

Uses · 14

• esc_attr()Escaping for HTML attributes.
• current_user_can()Returns whether the current user has the specified capability.
• wp_default_editor()Finds out which editor should be displayed by default.
• _x()Retrieves translated string with gettext context.
• wp_print_styles()Displays styles that are in the $handles queue.
• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• add_filter()Adds a callback function to a filter hook.
• remove_filter()Removes a callback function from a filter hook.
• has_filter()Checks if any filter has been registered for a hook.
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.
• stripos()

Used by · 1

• wp_editor()Renders an editor.

Source

View on Trac ↗View on GitHub ↗

159	public static function editor( $content, $editor_id, $settings = array() ) {160		$set            = self::parse_settings( $editor_id, $settings );161		$editor_class   = ' class="' . trim( esc_attr( $set['editor_class'] ) . ' wp-editor-area' ) . '"';162		$tabindex       = $set['tabindex'] ? ' tabindex="' . (int) $set['tabindex'] . '"' : '';163		$default_editor = 'html';164		$buttons        = '';165		$autocomplete   = '';166		$editor_id_attr = esc_attr( $editor_id );167 168		if ( $set['drag_drop_upload'] ) {169			self::$drag_drop_upload = true;170		}171 172		if ( ! empty( $set['editor_height'] ) ) {173			$height = ' style="height: ' . (int) $set['editor_height'] . 'px"';174		} else {175			$height = ' rows="' . (int) $set['textarea_rows'] . '"';176		}177 178		if ( ! current_user_can( 'upload_files' ) ) {179			$set['media_buttons'] = false;180		}181 182		if ( self::$this_tinymce ) {183			$autocomplete = ' autocomplete="off"';184 185			if ( self::$this_quicktags ) {186				$default_editor = $set['default_editor'] ? $set['default_editor'] : wp_default_editor();187				// 'html' is used for the "Text" editor tab.188				if ( 'html' !== $default_editor ) {189					$default_editor = 'tinymce';190				}191				$tmce_active = ( 'html' === $default_editor ) ? ' aria-pressed="true"' : '';192				$html_active = ( 'html' === $default_editor ) ? '' : ' aria-pressed="true"';193 194				$buttons .= '<button type="button" id="' . $editor_id_attr . '-tmce"' . $html_active . ' class="wp-switch-editor switch-tmce"' .195					' data-wp-editor-id="' . $editor_id_attr . '">' . _x( 'Visual', 'Name for the Visual editor tab' ) . "</button>\n";196				$buttons .= '<button type="button" id="' . $editor_id_attr . '-html"' . $tmce_active . ' class="wp-switch-editor switch-html"' .197					' data-wp-editor-id="' . $editor_id_attr . '">' . _x( 'Text', 'Name for the Text editor tab (formerly HTML)' ) . "</button>\n";198			} else {199				$default_editor = 'tinymce';200			}201		}202 203		$switch_class = 'html' === $default_editor ? 'html-active' : 'tmce-active';204		$wrap_class   = 'wp-core-ui wp-editor-wrap ' . $switch_class;205 206		if ( $set['_content_editor_dfw'] ) {207			$wrap_class .= ' has-dfw';208		}209 210		echo '<div id="wp-' . $editor_id_attr . '-wrap" class="' . $wrap_class . '">';211 212		if ( self::$editor_buttons_css ) {213			wp_print_styles( 'editor-buttons' );214			self::$editor_buttons_css = false;215		}216 217		if ( ! empty( $set['editor_css'] ) ) {218			echo $set['editor_css'] . "\n";219		}220 221		if ( ! empty( $buttons ) || $set['media_buttons'] ) {222			echo '<div id="wp-' . $editor_id_attr . '-editor-tools" class="wp-editor-tools hide-if-no-js">';223 224			if ( $set['media_buttons'] ) {225				self::$has_medialib = true;226 227				if ( ! function_exists( 'media_buttons' ) ) {228					require ABSPATH . 'wp-admin/includes/media.php';229				}230 231				echo '<div id="wp-' . $editor_id_attr . '-media-buttons" class="wp-media-buttons">';232 233				/**234				 * Fires after the default media button(s) are displayed.235				 *236				 * @since 2.5.0237				 *238				 * @param string $editor_id Unique editor identifier, e.g. 'content'.

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 6.7.7 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.