WP_Widget_Text::form( array $instance )

Compatibility

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

Parameters

$instancearray

Current settings.

Performance profile

How much work a call to WP_Widget_Text::form() 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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

81–113

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below WP_Widget_Text::form()

Further down the call graph this can also reach cache, serialize, 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 · 5 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( the_editor_content )filterline 474 (+20 into the body)

   Filters the default editor content.

Uses · 14

• wp_parse_args()Merges user defined arguments into defaults array.
• user_can_richedit()Determines whether the user can access the visual editor.
• add_filter()Adds a callback function to a filter hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• remove_filter()Removes a callback function from a filter hook.
• esc_attr()Escaping for HTML attributes.
• _e()Displays translated text.
• __()Retrieves the translation of $text.
• wp_admin_notice()Outputs an admin notice.
• esc_textarea()Escaping for textarea values.
• checked()Outputs the HTML checked attribute.
• WP_Widget_Text::is_legacy_instance()Determines whether a given instance is legacy and should bypass using TinyMCE.

Source code

View on Trac ↗View on GitHub ↗

454	public function form( $instance ) {455		$instance = wp_parse_args(456			(array) $instance,457			array(458				'title' => '',459				'text'  => '',460			)461		);462		?>463		<?php if ( ! $this->is_legacy_instance( $instance ) ) : ?>464			<?php465 466			if ( user_can_richedit() ) {467				add_filter( 'the_editor_content', 'format_for_editor', 10, 2 );468				$default_editor = 'tinymce';469			} else {470				$default_editor = 'html';471			}472 473			/** This filter is documented in wp-includes/class-wp-editor.php */474			$text = apply_filters( 'the_editor_content', $instance['text'], $default_editor );475 476			// Reset filter addition.477			if ( user_can_richedit() ) {478				remove_filter( 'the_editor_content', 'format_for_editor' );479			}480 481			// Prevent premature closing of textarea in case format_for_editor() didn't apply or the_editor_content filter did a wrong thing.482			$escaped_text = preg_replace( '#</textarea#i', '&lt;/textarea', $text );483 484			?>485			<input id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" class="title sync-input" type="hidden" value="<?php echo esc_attr( $instance['title'] ); ?>">486			<textarea id="<?php echo $this->get_field_id( 'text' ); ?>" name="<?php echo $this->get_field_name( 'text' ); ?>" class="text sync-input" hidden><?php echo $escaped_text; ?></textarea>487			<input id="<?php echo $this->get_field_id( 'filter' ); ?>" name="<?php echo $this->get_field_name( 'filter' ); ?>" class="filter sync-input" type="hidden" value="on">488			<input id="<?php echo $this->get_field_id( 'visual' ); ?>" name="<?php echo $this->get_field_name( 'visual' ); ?>" class="visual sync-input" type="hidden" value="on">489		<?php else : ?>490			<input id="<?php echo $this->get_field_id( 'visual' ); ?>" name="<?php echo $this->get_field_name( 'visual' ); ?>" class="visual" type="hidden" value="">491			<p>492				<label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label>493				<input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" />494			</p>495			<?php496			if ( ! isset( $instance['visual'] ) ) {497				$widget_info_message = __( 'This widget may contain code that may work better in the &#8220;Custom HTML&#8221; widget. How about trying that widget instead?' );498			} else {499				$widget_info_message = __( 'This widget may have contained code that may work better in the &#8220;Custom HTML&#8221; widget. If you have not yet, how about trying that widget instead?' );500			}501 502			wp_admin_notice(503				$widget_info_message,504				array(505					'type'               => 'info',506					'additional_classes' => array( 'notice-alt', 'inline' ),507				)508			);509			?>510			<p>511				<label for="<?php echo $this->get_field_id( 'text' ); ?>"><?php _e( 'Content:' ); ?></label>512				<textarea class="widefat" rows="16" cols="20" id="<?php echo $this->get_field_id( 'text' ); ?>" name="<?php echo $this->get_field_name( 'text' ); ?>"><?php echo esc_textarea( $instance['text'] ); ?></textarea>513			</p>514			<p>515				<input id="<?php echo $this->get_field_id( 'filter' ); ?>" name="<?php echo $this->get_field_name( 'filter' ); ?>" type="checkbox"<?php checked( ! empty( $instance['filter'] ) ); ?> />&nbsp;<label for="<?php echo $this->get_field_id( 'filter' ); ?>"><?php _e( 'Automatically add paragraphs' ); ?></label>516			</p>517			<?php518		endif;519	}

Changelog

Introduced in 2.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.7.7 tag, from src/wp-includes/widgets/class-wp-widget-text.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.