WP_Widget_Links::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_Links::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

Heavy

Reaches the database via get_terms().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

235–238

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• querycontent queryget_terms()called directly
• hookthird-party callbacksapply_filters()one call below WP_Widget_Links::form()

Further down the call graph this can also reach option, cache, 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 · 1 distinct outcome

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

Uses · 9

• wp_parse_args()Merges user defined arguments into defaults array.
• get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.
• _e()Displays translated text.
• _ex()Displays translated string with gettext context.
• selected()Outputs the HTML selected attribute.
• esc_html()Escaping for HTML blocks.
• checked()Outputs the HTML checked attribute.
• WP_Widget_Links::get_field_id()
• WP_Widget_Links::get_field_name()

Source code

View on Trac ↗View on GitHub ↗

125	public function form( $instance ) {126 127		// Defaults.128		$instance  = wp_parse_args(129			(array) $instance,130			array(131				'images'      => true,132				'name'        => true,133				'description' => false,134				'rating'      => false,135				'category'    => false,136				'orderby'     => 'name',137				'limit'       => -1,138			)139		);140		$link_cats = get_terms( array( 'taxonomy' => 'link_category' ) );141		$limit     = (int) $instance['limit'];142		if ( ! $limit ) {143			$limit = -1;144		}145		?>146		<p>147			<label for="<?php echo $this->get_field_id( 'category' ); ?>"><?php _e( 'Select Link Category:' ); ?></label>148			<select class="widefat" id="<?php echo $this->get_field_id( 'category' ); ?>" name="<?php echo $this->get_field_name( 'category' ); ?>">149				<option value=""><?php _ex( 'All Links', 'links widget' ); ?></option>150				<?php foreach ( $link_cats as $link_cat ) : ?>151					<option value="<?php echo (int) $link_cat->term_id; ?>" <?php selected( $instance['category'], $link_cat->term_id ); ?>>152						<?php echo esc_html( $link_cat->name ); ?>153					</option>154				<?php endforeach; ?>155			</select>156			<label for="<?php echo $this->get_field_id( 'orderby' ); ?>"><?php _e( 'Sort by:' ); ?></label>157			<select name="<?php echo $this->get_field_name( 'orderby' ); ?>" id="<?php echo $this->get_field_id( 'orderby' ); ?>" class="widefat">158				<option value="name"<?php selected( $instance['orderby'], 'name' ); ?>><?php _e( 'Link title' ); ?></option>159				<option value="rating"<?php selected( $instance['orderby'], 'rating' ); ?>><?php _e( 'Link rating' ); ?></option>160				<option value="id"<?php selected( $instance['orderby'], 'id' ); ?>><?php _e( 'Link ID' ); ?></option>161				<option value="rand"<?php selected( $instance['orderby'], 'rand' ); ?>><?php _ex( 'Random', 'Links widget' ); ?></option>162			</select>163		</p>164 165		<p>166			<input class="checkbox" type="checkbox"<?php checked( $instance['images'], true ); ?> id="<?php echo $this->get_field_id( 'images' ); ?>" name="<?php echo $this->get_field_name( 'images' ); ?>" />167			<label for="<?php echo $this->get_field_id( 'images' ); ?>"><?php _e( 'Show Link Image' ); ?></label>168			<br />169 170			<input class="checkbox" type="checkbox"<?php checked( $instance['name'], true ); ?> id="<?php echo $this->get_field_id( 'name' ); ?>" name="<?php echo $this->get_field_name( 'name' ); ?>" />171			<label for="<?php echo $this->get_field_id( 'name' ); ?>"><?php _e( 'Show Link Name' ); ?></label>172			<br />173 174			<input class="checkbox" type="checkbox"<?php checked( $instance['description'], true ); ?> id="<?php echo $this->get_field_id( 'description' ); ?>" name="<?php echo $this->get_field_name( 'description' ); ?>" />175			<label for="<?php echo $this->get_field_id( 'description' ); ?>"><?php _e( 'Show Link Description' ); ?></label>176			<br />177 178			<input class="checkbox" type="checkbox"<?php checked( $instance['rating'], true ); ?> id="<?php echo $this->get_field_id( 'rating' ); ?>" name="<?php echo $this->get_field_name( 'rating' ); ?>" />179			<label for="<?php echo $this->get_field_id( 'rating' ); ?>"><?php _e( 'Show Link Rating' ); ?></label>180		</p>181 182		<p>183			<label for="<?php echo $this->get_field_id( 'limit' ); ?>"><?php _e( 'Number of links to show:' ); ?></label>184			<input id="<?php echo $this->get_field_id( 'limit' ); ?>" name="<?php echo $this->get_field_name( 'limit' ); ?>" type="text" value="<?php echo ( -1 !== $limit ) ? (int) $limit : ''; ?>" size="3" />185		</p>186		<?php187	}

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.9.7 tag, from src/wp-includes/widgets/class-wp-widget-links.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.