WP_Screen::render_screen_options( array $options = array() )

Compatibility

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

Parameters

$optionsarrayoptional

Options for the tab.Default: array()

• $wrapbool

  Whether the screen-options-wrap div will be included. Defaults to true.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

40–66

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

Plugin surface

1 hook

Third-party callbacks on 'screen_options_show_submit' 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

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 · 8 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( screen_options_show_submit )filterline 1097 (+43 into the body)

   Filters whether to show the Screen Options submit button.

Uses · 11

• wp_parse_args()Merges user defined arguments into defaults array.
• esc_attr__()Retrieves the translation of $text and escapes it for safe use in an attribute.
• wp_nonce_field()Retrieves or display nonce hidden field for forms.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).
• __()Retrieves the translation of $text.
• WP_Screen::render_meta_boxes_preferences()Renders the meta boxes preferences.
• WP_Screen::render_list_table_columns_preferences()Renders the list table columns preferences.
• WP_Screen::render_screen_layout()Renders the option for number of columns on the page.
• WP_Screen::render_per_page_options()Renders the items per page option.
• WP_Screen::render_view_mode()Renders the list table view mode preferences.

Used by · 1

• WP_Screen::render_screen_meta()Renders the screen's help section.

Source code

View on Trac ↗View on GitHub ↗

1054	public function render_screen_options( $options = array() ) {1055		$options = wp_parse_args(1056			$options,1057			array(1058				'wrap' => true,1059			)1060		);1061 1062		$wrapper_start = '';1063		$wrapper_end   = '';1064		$form_start    = '';1065		$form_end      = '';1066 1067		// Output optional wrapper.1068		if ( $options['wrap'] ) {1069			$wrapper_start = '<div id="screen-options-wrap" class="hidden" tabindex="-1" aria-label="' . esc_attr__( 'Screen Options Tab' ) . '">';1070			$wrapper_end   = '</div>';1071		}1072 1073		// Don't output the form and nonce for the widgets accessibility mode links.1074		if ( 'widgets' !== $this->base ) {1075			$form_start = "\n<form id='adv-settings' method='post'>\n";1076			$form_end   = "\n" . wp_nonce_field( 'screen-options-nonce', 'screenoptionnonce', false, false ) . "\n</form>\n";1077		}1078 1079		echo $wrapper_start . $form_start;1080 1081		$this->render_meta_boxes_preferences();1082		$this->render_list_table_columns_preferences();1083		$this->render_screen_layout();1084		$this->render_per_page_options();1085		$this->render_view_mode();1086		echo $this->_screen_settings;1087 1088		/**1089		 * Filters whether to show the Screen Options submit button.1090		 *1091		 * @since 4.4.01092		 *1093		 * @param bool      $show_button Whether to show Screen Options submit button.1094		 *                               Default false.1095		 * @param WP_Screen $screen      Current WP_Screen instance.1096		 */1097		$show_button = apply_filters( 'screen_options_show_submit', false, $this );1098 1099		if ( $show_button ) {1100			submit_button( __( 'Apply' ), 'primary', 'screen-options-apply', true );1101		}1102 1103		echo $form_end . $wrapper_end;1104	}

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.1.0 tag, from src/wp-admin/includes/class-wp-screen.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.