_WP_Editors::editor_settings( string $editor_id, array $set )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$editor_idstring

Unique editor identifier, e.g. 'content'.

$setarray

Array of editor arguments.

Performance profile

How much work a call to _WP_Editors::editor_settings() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9–185

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 570.

Plugin surface

14 hooks

Third-party callbacks on 'quicktags_settings', 'teeny_mce_plugins', 'mce_external_plugins' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()called directly

Further down the call graph this can also reach cache, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 27 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _WP_Editors::editor_settings() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 14

14 hooks fire while _WP_Editors::editor_settings() runs, in this order:

1. 1
   apply_filters( quicktags_settings )filterline 361 (+40 into the body)

   Filters the Quicktags settings.

2. 2
   apply_filters( teeny_mce_plugins )filterline 386 (+65 into the body)

   Filters the list of teenyMCE plugins.

3. 3
   apply_filters( mce_external_plugins )filterline 421 (+100 into the body)

   Filters the list of TinyMCE external plugins.

4. 4
   apply_filters( tiny_mce_plugins )filterline 461 (+140 into the body)

   Filters the list of default TinyMCE plugins.

5. 5
   apply_filters( mce_external_languages )filterline 489 (+168 into the body)

   Filters the translations loaded for external TinyMCE 3.x plugins.

6. 6
   apply_filters( disable_captions )filterline 567 (+246 into the body)

   Filters whether to disable captions.

7. 7
   apply_filters( mce_css )filterline 600 (+279 into the body)

   Filters the comma-delimited list of stylesheets to load in TinyMCE.

8. 8
   apply_filters( teeny_mce_buttons )filterline 638 (+317 into the body)

   Filters the list of teenyMCE buttons (Code tab).

9. 9
   apply_filters( mce_buttons )filterline 680 (+359 into the body)

   Filters the first-row list of TinyMCE buttons (Visual tab).

10. 10
    apply_filters( mce_buttons_2 )filterline 709 (+388 into the body)

    Filters the second-row list of TinyMCE buttons (Visual tab).

11. 11
    apply_filters( mce_buttons_3 )filterline 721 (+400 into the body)

    Filters the third-row list of TinyMCE buttons (Visual tab).

12. 12
    apply_filters( mce_buttons_4 )filterline 733 (+412 into the body)

    Filters the fourth-row list of TinyMCE buttons (Visual tab).

13. 13
    apply_filters( teeny_mce_before_init )filterline 804 (+483 into the body)

    Filters the teenyMCE config before init.

14. 14
    apply_filters( tiny_mce_before_init )filterline 817 (+496 into the body)

    Filters the TinyMCE config before init.

Uses · 20

• is_admin()Determines whether the current request is for an administrative interface page.
• add_action()Adds a callback function to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• set_url_scheme()Sets the scheme for a URL.
• content_url()Retrieves the URL to the content directory.
• trailingslashit()Appends a trailing slash.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• get_editor_stylesheets()Retrieves any registered editor stylesheet URLs.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_is_mobile()Test if the current browser runs on a mobile device (smart phone, tablet, etc.).
• get_post()Retrieves post data given a post ID or post object.
• sanitize_html_class()Sanitizes an HTML classname to ensure it only contains valid characters.

Used by · 2

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

Source code

View on Trac ↗View on GitHub ↗

321	public static function editor_settings( $editor_id, $set ) {322		if ( empty( self::$first_init ) ) {323			if ( is_admin() ) {324				add_action( 'admin_print_footer_scripts', array( __CLASS__, 'editor_js' ), 50 );325				add_action( 'admin_print_footer_scripts', array( __CLASS__, 'force_uncompressed_tinymce' ), 1 );326				add_action( 'admin_print_footer_scripts', array( __CLASS__, 'enqueue_scripts' ), 1 );327			} else {328				add_action( 'wp_print_footer_scripts', array( __CLASS__, 'editor_js' ), 50 );329				add_action( 'wp_print_footer_scripts', array( __CLASS__, 'force_uncompressed_tinymce' ), 1 );330				add_action( 'wp_print_footer_scripts', array( __CLASS__, 'enqueue_scripts' ), 1 );331			}332		}333 334		if ( self::$this_quicktags ) {335 336			$qt_init = array(337				'id'      => $editor_id,338				'buttons' => '',339			);340 341			if ( is_array( $set['quicktags'] ) ) {342				$qt_init = array_merge( $qt_init, $set['quicktags'] );343			}344 345			if ( empty( $qt_init['buttons'] ) ) {346				$qt_init['buttons'] = 'strong,em,link,block,del,ins,img,ul,ol,li,code,more,close';347			}348 349			if ( $set['_content_editor_dfw'] ) {350				$qt_init['buttons'] .= ',dfw';351			}352 353			/**354			 * Filters the Quicktags settings.355			 *356			 * @since 3.3.0357			 *358			 * @param array  $qt_init   Quicktags settings.359			 * @param string $editor_id Unique editor identifier, e.g. 'content'.360			 */361			$qt_init = apply_filters( 'quicktags_settings', $qt_init, $editor_id );362 363			self::$qt_settings[ $editor_id ] = $qt_init;364 365			self::$qt_buttons = array_merge( self::$qt_buttons, explode( ',', $qt_init['buttons'] ) );366		}367 368		if ( self::$this_tinymce ) {369 370			if ( empty( self::$first_init ) ) {371				$baseurl     = self::get_baseurl();372				$mce_locale  = self::get_mce_locale();373				$ext_plugins = '';374 375				if ( $set['teeny'] ) {376 377					/**378					 * Filters the list of teenyMCE plugins.379					 *380					 * @since 2.7.0381					 * @since 3.3.0 The `$editor_id` parameter was added.382					 *383					 * @param array  $plugins   An array of teenyMCE plugins.384					 * @param string $editor_id Unique editor identifier, e.g. 'content'.385					 */386					$plugins = apply_filters(387						'teeny_mce_plugins',388						array(389							'colorpicker',390							'lists',391							'fullscreen',392							'image',393							'wordpress',394							'wpeditimage',395							'wplink',396						),397						$editor_id398					);399				} else {400

Changelog

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