_get_list_table( string $class_name, array $args = array() ): WP_List_Table|false

Compatibility

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

Parameters

$class_namestring

The type of the list table, which is the class name.

$argsarrayoptional

Arguments to pass to the class. Accepts 'screen'.Default: array()

Return value

WP_List_Table|false

List table object on success, false if the class does not exist.

Performance profile

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

6–36

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

Plugin surface

1 hook

Third-party callbacks on 'wp_list_table_class_name' run inside this call, and their cost is not bounded by anything here.

Called by

18

18 places 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 · 4 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( wp_list_table_class_name )filterline 68 (+47 into the body)

   Filters the list table class to instantiate.

Uses · 3

• convert_to_screen()Converts a screen string to a screen object.
• get_current_screen()Get the current screen object
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 18

• display_theme()Prints a theme on the Install Themes pages.
• display_themes()Displays theme content based on theme list.
• install_theme_information()Displays theme information in dialog box form.
• post_comment_meta_box()Displays comments for post.
• wp_ajax_add_tag()Handles adding a tag via AJAX.
• wp_ajax_add_user()Handles adding a user via AJAX.
• wp_ajax_edit_comment()Handles editing a comment via AJAX.
• wp_ajax_fetch_list()Handles fetching a list table via AJAX.
• wp_ajax_get_comments()Handles getting comments via AJAX.
• wp_ajax_inline_save()Handles Quick Edit saving a post from a list table via AJAX.
• wp_ajax_inline_save_tax()Handles Quick Edit saving for a term via AJAX.
• wp_ajax_replyto_comment()Handles replying to a comment via AJAX.

Source code

View on Trac ↗View on GitHub ↗

21function _get_list_table( $class_name, $args = array() ) {22	$core_classes = array(23		// Site Admin.24		'WP_Posts_List_Table'                         => 'posts',25		'WP_Media_List_Table'                         => 'media',26		'WP_Terms_List_Table'                         => 'terms',27		'WP_Users_List_Table'                         => 'users',28		'WP_Comments_List_Table'                      => 'comments',29		'WP_Post_Comments_List_Table'                 => array( 'comments', 'post-comments' ),30		'WP_Links_List_Table'                         => 'links',31		'WP_Plugin_Install_List_Table'                => 'plugin-install',32		'WP_Themes_List_Table'                        => 'themes',33		'WP_Theme_Install_List_Table'                 => array( 'themes', 'theme-install' ),34		'WP_Plugins_List_Table'                       => 'plugins',35		'WP_Application_Passwords_List_Table'         => 'application-passwords',36 37		// Network Admin.38		'WP_MS_Sites_List_Table'                      => 'ms-sites',39		'WP_MS_Users_List_Table'                      => 'ms-users',40		'WP_MS_Themes_List_Table'                     => 'ms-themes',41 42		// Privacy requests tables.43		'WP_Privacy_Data_Export_Requests_List_Table'  => 'privacy-data-export-requests',44		'WP_Privacy_Data_Removal_Requests_List_Table' => 'privacy-data-removal-requests',45	);46 47	if ( isset( $core_classes[ $class_name ] ) ) {48		foreach ( (array) $core_classes[ $class_name ] as $required ) {49			require_once ABSPATH . 'wp-admin/includes/class-wp-' . $required . '-list-table.php';50		}51 52		if ( isset( $args['screen'] ) ) {53			$args['screen'] = convert_to_screen( $args['screen'] );54		} elseif ( isset( $GLOBALS['hook_suffix'] ) ) {55			$args['screen'] = get_current_screen();56		} else {57			$args['screen'] = null;58		}59 60		/**61		 * Filters the list table class to instantiate.62		 *63		 * @since 6.1.064		 *65		 * @param string $class_name The list table class to use.66		 * @param array  $args       An array containing _get_list_table() arguments.67		 */68		$custom_class_name = apply_filters( 'wp_list_table_class_name', $class_name, $args );69 70		if ( is_string( $custom_class_name ) && class_exists( $custom_class_name ) ) {71			$class_name = $custom_class_name;72		}73 74		return new $class_name( $args );75	}76 77	return false;78}

Changelog

Introduced in 3.1.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/list-table.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.