WP_Screen::render_screen_meta()

Description

Compatibility

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

Performance profile

How much work a call to WP_Screen::render_screen_meta() 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 how much data it finds.

Instructions

92–153

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

Plugin surface

4 hooks

Third-party callbacks on 'contextual_help_list', 'contextual_help', 'default_contextual_help' 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_deprecated()called directly

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

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

Hooks and filters fired · 4

4 hooks fire while WP_Screen::render_screen_meta() runs, in this order:

1. 1
   do_action( contextual_help_list )filter_deprecatedline 802 (+12 into the body)

   Filters the legacy contextual help list.

2. 2
   do_action( contextual_help )filter_deprecatedline 822 (+32 into the body)

   Filters the legacy contextual help text.

3. 3
   do_action( default_contextual_help )filter_deprecatedline 841 (+51 into the body)

   Filters the default legacy contextual help text.

4. 4
   apply_filters( screen_layout_columns )filterline 943 (+153 into the body)

   Filters the array of screen layout columns.

Uses · 16

• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.
• esc_attr_e()Displays translated text that has been escaped for safe use in an attribute.
• esc_url()Checks and cleans a URL.
• esc_html()Escaping for HTML blocks.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_user_option()Retrieves user option that can be either per Site or per Network.
• _e()Displays translated text.
• WP_Screen::get_help_tabs()Gets the help tabs registered for the screen.
• WP_Screen::add_help_tab()Adds a help tab to the contextual help for the screen.
• WP_Screen::get_help_sidebar()Gets the content from a contextual help sidebar.

Source code

View on Trac ↗View on GitHub ↗

790	public function render_screen_meta() {791 792		/**793		 * Filters the legacy contextual help list.794		 *795		 * @since 2.7.0796		 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or797		 *                   {@see get_current_screen()->remove_help_tab()} instead.798		 *799		 * @param array     $old_compat_help Old contextual help.800		 * @param WP_Screen $screen          Current WP_Screen instance.801		 */802		self::$_old_compat_help = apply_filters_deprecated(803			'contextual_help_list',804			array( self::$_old_compat_help, $this ),805			'3.3.0',806			'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'807		);808 809		$old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : '';810 811		/**812		 * Filters the legacy contextual help text.813		 *814		 * @since 2.7.0815		 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or816		 *                   {@see get_current_screen()->remove_help_tab()} instead.817		 *818		 * @param string    $old_help  Help text that appears on the screen.819		 * @param string    $screen_id Screen ID.820		 * @param WP_Screen $screen    Current WP_Screen instance.821		 */822		$old_help = apply_filters_deprecated(823			'contextual_help',824			array( $old_help, $this->id, $this ),825			'3.3.0',826			'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'827		);828 829		// Default help only if there is no old-style block of text and no new-style help tabs.830		if ( empty( $old_help ) && ! $this->get_help_tabs() ) {831 832			/**833			 * Filters the default legacy contextual help text.834			 *835			 * @since 2.8.0836			 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or837			 *                   {@see get_current_screen()->remove_help_tab()} instead.838			 *839			 * @param string $old_help_default Default contextual help text.840			 */841			$default_help = apply_filters_deprecated(842				'default_contextual_help',843				array( '' ),844				'3.3.0',845				'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'846			);847			if ( $default_help ) {848				$old_help = '<p>' . $default_help . '</p>';849			}850		}851 852		if ( $old_help ) {853			$this->add_help_tab(854				array(855					'id'      => 'old-contextual-help',856					'title'   => __( 'Overview' ),857					'content' => $old_help,858				)859			);860		}861 862		$help_sidebar = $this->get_help_sidebar();863 864		$help_class = 'hidden';865		if ( ! $help_sidebar ) {866			$help_class .= ' no-sidebar';867		}868 869		// Time to render!

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 6.9.7 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.