WP_List_Table::__construct( array|string $args = array() )

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|stringoptional

Array or string of arguments.Default: array()

• $pluralstringdefault: empty

  Plural value used for labels and the objects being listed. This affects things such as CSS class-names and nonces used in the list table, e.g. 'posts'.

• $singularstringdefault: false

  Singular label for an object being listed, e.g. 'post'. Default empty @type bool $ajax Whether the list table supports Ajax. This includes loading and sorting data, for example. If true, the class will call the _js_vars() method in the footer to provide variables to any scripts handling Ajax events.

• $screenstringdefault: null

  String containing the hook name used to determine the current screen. If left null, the current screen will be automatically set.

Performance profile

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

49–70

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

10

10 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_List_Table::__construct()

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

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

Uses · 6

• wp_parse_args()Merges user defined arguments into defaults array.
• convert_to_screen()Converts a screen string to a screen object.
• add_filter()Adds a callback function to a filter hook.
• sanitize_key()Sanitizes a string key.
• add_action()Adds a callback function to an action hook.
• __()Retrieves the translation of $text.

Used by · 10

• WP_Comments_List_Table::__construct()Constructor.
• WP_Links_List_Table::__construct()Constructor.
• WP_MS_Sites_List_Table::__construct()Constructor.
• WP_MS_Themes_List_Table::__construct()Constructor.
• WP_Media_List_Table::__construct()Constructor.
• WP_Plugins_List_Table::__construct()Constructor.
• WP_Posts_List_Table::__construct()Constructor.
• WP_Terms_List_Table::__construct()Constructor.
• WP_Themes_List_Table::__construct()Constructor.
• WP_Users_List_Table::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

138	public function __construct( $args = array() ) {139		$args = wp_parse_args(140			$args,141			array(142				'plural'   => '',143				'singular' => '',144				'ajax'     => false,145				'screen'   => null,146			)147		);148 149		$this->screen = convert_to_screen( $args['screen'] );150 151		add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 );152 153		if ( ! $args['plural'] ) {154			$args['plural'] = $this->screen->base;155		}156 157		$args['plural']   = sanitize_key( $args['plural'] );158		$args['singular'] = sanitize_key( $args['singular'] );159 160		$this->_args = $args;161 162		if ( $args['ajax'] ) {163			// wp_enqueue_script( 'list-table' );164			add_action( 'admin_footer', array( $this, '_js_vars' ) );165		}166 167		if ( empty( $this->modes ) ) {168			$this->modes = array(169				'list'    => __( 'Compact view' ),170				'excerpt' => __( 'Extended view' ),171			);172		}173	}

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