WP_Screen::show_screen_options(): bool

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

bool

Whether to show the Screen Options tab for the current screen.

Performance profile

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

6–73

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

Plugin surface

2 hooks

Third-party callbacks on 'screen_settings', 'screen_options_show_screen' 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 query, 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 · 5 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_Screen::show_screen_options() runs, in this order:

1. 1
   apply_filters( screen_settings )filterline 1024 (+28 into the body)

   Filters the screen settings text displayed in the Screen Options tab.

2. 2
   apply_filters( screen_options_show_screen )filterline 1039 (+43 into the body)

   Filters whether to show the Screen Options tab.

Uses · 6

• get_column_headers()Get the column headers for a screen
• __()Retrieves the translation of $text.
• checked()Outputs the HTML checked attribute.
• get_user_setting()Retrieves user interface setting value based on setting name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Screen::get_option()Gets the arguments for an option for the screen.

Used by · 1

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

Source code

View on Trac ↗View on GitHub ↗

996	public function show_screen_options() {997		global $wp_meta_boxes;998 999		if ( is_bool( $this->_show_screen_options ) ) {1000			return $this->_show_screen_options;1001		}1002 1003		$columns = get_column_headers( $this );1004 1005		$show_screen = ! empty( $wp_meta_boxes[ $this->id ] ) || $columns || $this->get_option( 'per_page' );1006 1007		$this->_screen_settings = '';1008 1009		if ( 'post' === $this->base ) {1010			$expand                 = '<fieldset class="editor-expand hidden"><legend>' . __( 'Additional settings' ) . '</legend><label for="editor-expand-toggle">';1011			$expand                .= '<input type="checkbox" id="editor-expand-toggle"' . checked( get_user_setting( 'editor_expand', 'on' ), 'on', false ) . ' />';1012			$expand                .= __( 'Enable full-height editor and distraction-free functionality.' ) . '</label></fieldset>';1013			$this->_screen_settings = $expand;1014		}1015 1016		/**1017		 * Filters the screen settings text displayed in the Screen Options tab.1018		 *1019		 * @since 3.0.01020		 *1021		 * @param string    $screen_settings Screen settings.1022		 * @param WP_Screen $screen          WP_Screen object.1023		 */1024		$this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this );1025 1026		if ( $this->_screen_settings || $this->_options ) {1027			$show_screen = true;1028		}1029 1030		/**1031		 * Filters whether to show the Screen Options tab.1032		 *1033		 * @since 3.2.01034		 *1035		 * @param bool      $show_screen Whether to show Screen Options tab.1036		 *                               Default true.1037		 * @param WP_Screen $screen      Current WP_Screen instance.1038		 */1039		$this->_show_screen_options = apply_filters( 'screen_options_show_screen', $show_screen, $this );1040		return $this->_show_screen_options;1041	}

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.