WP_List_Table::get_column_info(): array<int,

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

array<int,

array|string> Column information.

Performance profile

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

11–45

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

Plugin surface

1 hook

Third-party callbacks on 'manage_{$this->screen->id}_sortable_columns' run inside this call, and their cost is not bounded by anything here.

Called by

4

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

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( manage_{$this->screen->id}_sortable_columns )filterline 1339 (+41 into the body)

   Filters the list table sortable columns for a specific screen.

Uses · 5

• get_column_headers()Get the column headers for a screen
• get_hidden_columns()Get a list of hidden columns.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_List_Table::get_primary_column_name()Gets the name of the primary column.
• WP_List_Table::get_sortable_columns()Gets a list of sortable columns.

Used by · 4

• WP_List_Table::get_column_count()Returns the number of visible columns.
• WP_List_Table::print_column_headers()Prints column headers, accounting for hidden and sortable columns.
• WP_List_Table::print_table_description()Print a table description with information about current sorting and order.
• WP_List_Table::single_row_columns()Generates the columns for a single row of the table.

Source code

View on Trac ↗View on GitHub ↗

1298	protected function get_column_info() {1299		// $_column_headers is already set / cached.1300		if (1301			isset( $this->_column_headers ) &&1302			is_array( $this->_column_headers )1303		) {1304			/*1305			 * Backward compatibility for `$_column_headers` format prior to WordPress 4.3.1306			 *1307			 * In WordPress 4.3 the primary column name was added as a fourth item in the1308			 * column headers property. This ensures the primary column name is included1309			 * in plugins setting the property directly in the three item format.1310			 */1311			if ( 4 === count( $this->_column_headers ) ) {1312				return $this->_column_headers;1313			}1314 1315			$column_headers = array( array(), array(), array(), $this->get_primary_column_name() );1316			foreach ( $this->_column_headers as $key => $value ) {1317				$column_headers[ $key ] = $value;1318			}1319 1320			$this->_column_headers = $column_headers;1321 1322			return $this->_column_headers;1323		}1324 1325		$columns = get_column_headers( $this->screen );1326		$hidden  = get_hidden_columns( $this->screen );1327 1328		$sortable_columns = $this->get_sortable_columns();1329		/**1330		 * Filters the list table sortable columns for a specific screen.1331		 *1332		 * The dynamic portion of the hook name, `$this->screen->id`, refers1333		 * to the ID of the current screen.1334		 *1335		 * @since 3.1.01336		 *1337		 * @param array $sortable_columns An array of sortable columns.1338		 */1339		$_sortable = apply_filters( "manage_{$this->screen->id}_sortable_columns", $sortable_columns );1340 1341		$sortable = array();1342		foreach ( $_sortable as $id => $data ) {1343			if ( empty( $data ) ) {1344				continue;1345			}1346 1347			$data = (array) $data;1348			// Descending initial sorting.1349			if ( ! isset( $data[1] ) ) {1350				$data[1] = false;1351			}1352			// Current sorting translatable string.1353			if ( ! isset( $data[2] ) ) {1354				$data[2] = '';1355			}1356			// Initial view sorted column and asc/desc order, default: false.1357			if ( ! isset( $data[3] ) ) {1358				$data[3] = false;1359			}1360			// Initial order for the initial sorted column, default: false.1361			if ( ! isset( $data[4] ) ) {1362				$data[4] = false;1363			}1364 1365			$sortable[ $id ] = $data;1366		}1367 1368		$primary               = $this->get_primary_column_name();1369		$this->_column_headers = array( $columns, $hidden, $sortable, $primary );1370 1371		return $this->_column_headers;1372	}

Changelog

Introduced in 3.1.0. One change between 6.7.7 and 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.