get_default_block_editor_settings(): array

Compatibility

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

Return value

array

The default block editor settings.

Performance profile

How much work a call to get_default_block_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

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

88–108

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

Plugin surface

1 hook

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

Called by

1

1 place 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
• optionoption read or writeget_option()called directly
• filesystemfilesystem accessfile_exists()called directly
• cacheobject cachewp_cache_get()one call below get_default_block_editor_settings()
• serializeserialisationmaybe_unserialize()one call below get_default_block_editor_settings()

Further down the call graph this can also reach query 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 · 6 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( image_size_names_choose )filterline 168 (+13 into the body)

   Filters the names and labels of the default image sizes.

Uses · 12

• current_user_can()Returns whether the current user has the specified capability.
• wp_max_upload_size()Determines the maximum upload size allowed in php.ini.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• wp_get_registered_image_subsizes()Returns a normalized list of all currently registered image sub-sizes.
• get_theme_support()Gets the theme support arguments passed when registering that support.
• get_allowed_mime_types()Retrieves the list of allowed mime types and file extensions.
• get_default_block_categories()Returns the list of default categories for block types.
• is_rtl()Determines whether the current locale is right-to-left (RTL).
• admin_url()Retrieves the URL to the admin area for the current site.
• get_classic_theme_supports_block_editor_settings()Returns the classic theme supports settings for block editor.

Used by · 1

• get_block_editor_settings()Returns the contextualized block editor settings for a selected editor context.

Source code

View on Trac ↗View on GitHub ↗

155function get_default_block_editor_settings() {156	// Media settings.157 158	// wp_max_upload_size() can be expensive, so only call it when relevant for the current user.159	$max_upload_size = 0;160	if ( current_user_can( 'upload_files' ) ) {161		$max_upload_size = wp_max_upload_size();162		if ( ! $max_upload_size ) {163			$max_upload_size = 0;164		}165	}166 167	/** This filter is documented in wp-admin/includes/media.php */168	$image_size_names = apply_filters(169		'image_size_names_choose',170		array(171			'thumbnail' => __( 'Thumbnail' ),172			'medium'    => __( 'Medium' ),173			'large'     => __( 'Large' ),174			'full'      => __( 'Full Size' ),175		)176	);177 178	$available_image_sizes = array();179	foreach ( $image_size_names as $image_size_slug => $image_size_name ) {180		$available_image_sizes[] = array(181			'slug' => $image_size_slug,182			'name' => $image_size_name,183		);184	}185 186	$default_size       = get_option( 'image_default_size', 'large' );187	$image_default_size = in_array( $default_size, array_keys( $image_size_names ), true ) ? $default_size : 'large';188 189	$image_dimensions = array();190	$all_sizes        = wp_get_registered_image_subsizes();191	foreach ( $available_image_sizes as $size ) {192		$key = $size['slug'];193		if ( isset( $all_sizes[ $key ] ) ) {194			$image_dimensions[ $key ] = $all_sizes[ $key ];195		}196	}197 198	// These styles are used if the "no theme styles" options is triggered or on199	// themes without their own editor styles.200	$default_editor_styles_file = ABSPATH . WPINC . '/css/dist/block-editor/default-editor-styles.css';201 202	static $default_editor_styles_file_contents = false;203	if ( ! $default_editor_styles_file_contents && file_exists( $default_editor_styles_file ) ) {204		$default_editor_styles_file_contents = file_get_contents( $default_editor_styles_file );205	}206 207	$default_editor_styles = array();208	if ( $default_editor_styles_file_contents ) {209		$default_editor_styles = array(210			array( 'css' => $default_editor_styles_file_contents ),211		);212	}213 214	$editor_settings = array(215		'alignWide'                        => get_theme_support( 'align-wide' ),216		'allowedBlockTypes'                => true,217		'allowedMimeTypes'                 => get_allowed_mime_types(),218		'defaultEditorStyles'              => $default_editor_styles,219		'blockCategories'                  => get_default_block_categories(),220		'isRTL'                            => is_rtl(),221		'imageDefaultSize'                 => $image_default_size,222		'imageDimensions'                  => $image_dimensions,223		'imageEditing'                     => true,224		'imageSizes'                       => $available_image_sizes,225		'maxUploadFileSize'                => $max_upload_size,226		'__experimentalDashboardLink'      => admin_url( '/' ),227		// The following flag is required to enable the new Gallery block format on the mobile apps in 5.9.228		'__unstableGalleryWithImageBlocks' => true,229	);230 231	$theme_settings = get_classic_theme_supports_block_editor_settings();232	foreach ( $theme_settings as $key => $value ) {233		$editor_settings[ $key ] = $value;234	}

Changelog

Introduced in 5.8.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.9.7 tag, from src/wp-includes/block-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.