wppaste
WordPress

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

Since
3.2.0
Source
wp-admin/includes/class-wp-list-table.php:150
Constructor.

Description

The child class should call this constructor from its own constructor to override the default $args.

Compatibility

WordPress
since 3.2.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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.

WhenInstructionsCalls it makes
!empty($value)49–60wp_parse_args(), convert_to_screen(), sanitize_key(), sanitize_key()
empty($value)59–70wp_parse_args(), convert_to_screen(), sanitize_key(), sanitize_key(), __(), __()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 70 instructions, 49–70 executed per call, 3 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 6

Used by · 10

Source code

View on Trac View on GitHub 

	public function __construct( $args = array() ) {		$args = wp_parse_args(			$args,			array(				'plural'   => '',				'singular' => '',				'ajax'     => false,				'screen'   => null,			)		); 		$this->screen = convert_to_screen( $args['screen'] ); 		add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 ); 		if ( ! $args['plural'] ) {			$args['plural'] = $this->screen->base;		} 		$args['plural']   = sanitize_key( $args['plural'] );		$args['singular'] = sanitize_key( $args['singular'] ); 		$this->_args = $args; 		if ( $args['ajax'] ) {			// wp_enqueue_script( 'list-table' );			add_action( 'admin_footer', array( $this, '_js_vars' ) );		} 		if ( empty( $this->modes ) ) {			$this->modes = array(				'list'    => __( 'Compact view' ),				'excerpt' => __( 'Extended view' ),			);		}	}

Changelog

Introduced in 3.2.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-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.