wp_widget_rss_form( array|string $args, array $inputs = null )

Description

Compatibility

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

Parameters

$argsarray|string

Values for input fields.

$inputsarrayoptional

Override default display options.Default: null

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

67–194

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

Plugin surface

None

Nothing here hands control to plugin code.

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()one call below wp_widget_rss_form()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_widget_rss_form() 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.

Uses · 8

• wp_parse_args()Merges user defined arguments into defaults array.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• esc_attr()Escaping for HTML attributes.
• _e()Displays translated text.
• esc_url()Checks and cleans a URL.
• selected()Outputs the HTML selected attribute.
• checked()Outputs the HTML checked attribute.

Used by · 2

• WP_Widget_RSS::form()Outputs the settings form for the RSS widget.
• wp_dashboard_rss_control()Sets up the RSS dashboard widget control and $args to be used as input to wp_widget_rss_form().

Source code

View on Trac ↗View on GitHub ↗

1712function wp_widget_rss_form( $args, $inputs = null ) {1713	$default_inputs = array(1714		'url'          => true,1715		'title'        => true,1716		'items'        => true,1717		'show_summary' => true,1718		'show_author'  => true,1719		'show_date'    => true,1720	);1721	$inputs         = wp_parse_args( $inputs, $default_inputs );1722 1723	$args['title'] = $args['title'] ?? '';1724	$args['url']   = $args['url'] ?? '';1725	$args['items'] = (int) ( $args['items'] ?? 0 );1726 1727	if ( $args['items'] < 1 || 20 < $args['items'] ) {1728		$args['items'] = 10;1729	}1730 1731	$args['show_summary'] = (int) ( $args['show_summary'] ?? $inputs['show_summary'] );1732	$args['show_author']  = (int) ( $args['show_author'] ?? $inputs['show_author'] );1733	$args['show_date']    = (int) ( $args['show_date'] ?? $inputs['show_date'] );1734 1735	if ( ! empty( $args['error'] ) ) {1736		echo '<p class="widget-error"><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $args['error'] ) . '</p>';1737	}1738 1739	$esc_number = esc_attr( $args['number'] );1740	if ( $inputs['url'] ) :1741		?>1742	<p><label for="rss-url-<?php echo $esc_number; ?>"><?php _e( 'Enter the RSS feed URL here:' ); ?></label>1743	<input class="widefat" id="rss-url-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][url]" type="text" value="<?php echo esc_url( $args['url'] ); ?>" /></p>1744<?php endif; if ( $inputs['title'] ) : ?>1745	<p><label for="rss-title-<?php echo $esc_number; ?>"><?php _e( 'Give the feed a title (optional):' ); ?></label>1746	<input class="widefat" id="rss-title-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][title]" type="text" value="<?php echo esc_attr( $args['title'] ); ?>" /></p>1747<?php endif; if ( $inputs['items'] ) : ?>1748	<p><label for="rss-items-<?php echo $esc_number; ?>"><?php _e( 'How many items would you like to display?' ); ?></label>1749	<select id="rss-items-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][items]">1750	<?php1751	for ( $i = 1; $i <= 20; ++$i ) {1752		echo "<option value='$i' " . selected( $args['items'], $i, false ) . ">$i</option>";1753	}1754	?>1755	</select></p>1756<?php endif; if ( $inputs['show_summary'] || $inputs['show_author'] || $inputs['show_date'] ) : ?>1757	<p>1758	<?php if ( $inputs['show_summary'] ) : ?>1759		<input id="rss-show-summary-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_summary]" type="checkbox" value="1" <?php checked( $args['show_summary'] ); ?> />1760		<label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label><br />1761	<?php endif; if ( $inputs['show_author'] ) : ?>1762		<input id="rss-show-author-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_author]" type="checkbox" value="1" <?php checked( $args['show_author'] ); ?> />1763		<label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label><br />1764	<?php endif; if ( $inputs['show_date'] ) : ?>1765		<input id="rss-show-date-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_date]" type="checkbox" value="1" <?php checked( $args['show_date'] ); ?> />1766		<label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label><br />1767	<?php endif; ?>1768	</p>1769	<?php1770	endif; // End of display options.1771foreach ( array_keys( $default_inputs ) as $input ) :1772	if ( 'hidden' === $inputs[ $input ] ) :1773		$id = str_replace( '_', '-', $input );1774		?>1775<input type="hidden" id="rss-<?php echo esc_attr( $id ); ?>-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][<?php echo esc_attr( $input ); ?>]" value="<?php echo esc_attr( $args[ $input ] ); ?>" />1776		<?php1777	endif;1778	endforeach;1779}

Changelog

Introduced in 2.5.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.1.0 tag, from src/wp-includes/widgets.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.