WP_List_Table::print_column_headers( bool $with_id = true )

Compatibility

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

Parameters

$with_idbooloptional

Whether to set the ID attribute or not. Default true.Default: true

Performance profile

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

40–41

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place 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::print_column_headers()

Further down the call graph this can also reach option, cache, serialize, query 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 · 1 distinct outcome

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

Uses · 7

• set_url_scheme()Sets the scheme for a URL.
• remove_query_arg()Removes an item or items from a query string.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.
• add_query_arg()Retrieves a modified URL query string.
• WP_List_Table::get_column_info()Gets a list of all, hidden, and sortable columns, with filter applied.

Used by · 1

• WP_List_Table::display()Displays the table.

Source code

View on Trac ↗View on GitHub ↗

1408	public function print_column_headers( $with_id = true ) {1409		list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();1410 1411		$current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );1412		$current_url = remove_query_arg( 'paged', $current_url );1413 1414		// When users click on a column header to sort by other columns.1415		if ( isset( $_GET['orderby'] ) ) {1416			$current_orderby = $_GET['orderby'];1417			// In the initial view there's no orderby parameter.1418		} else {1419			$current_orderby = '';1420		}1421 1422		// Not in the initial view and descending order.1423		if ( isset( $_GET['order'] ) && 'desc' === $_GET['order'] ) {1424			$current_order = 'desc';1425		} else {1426			// The initial view is not always 'asc', we'll take care of this below.1427			$current_order = 'asc';1428		}1429 1430		if ( ! empty( $columns['cb'] ) ) {1431			static $cb_counter = 1;1432			$columns['cb']     = '<input id="cb-select-all-' . $cb_counter . '" type="checkbox" />1433			<label for="cb-select-all-' . $cb_counter . '">' .1434				'<span class="screen-reader-text">' .1435					/* translators: Hidden accessibility text. */1436					__( 'Select All' ) .1437				'</span>' .1438				'</label>';1439			++$cb_counter;1440		}1441 1442		foreach ( $columns as $column_key => $column_display_name ) {1443			$class          = array( 'manage-column', "column-$column_key" );1444			$aria_sort_attr = '';1445			$abbr_attr      = '';1446			$order_text     = '';1447 1448			if ( in_array( $column_key, $hidden, true ) ) {1449				$class[] = 'hidden';1450			}1451 1452			if ( 'cb' === $column_key ) {1453				$class[] = 'check-column';1454			} elseif ( in_array( $column_key, array( 'posts', 'comments', 'links' ), true ) ) {1455				$class[] = 'num';1456			}1457 1458			if ( $column_key === $primary ) {1459				$class[] = 'column-primary';1460			}1461 1462			if ( isset( $sortable[ $column_key ] ) ) {1463				$orderby       = $sortable[ $column_key ][0] ?? '';1464				$desc_first    = $sortable[ $column_key ][1] ?? false;1465				$abbr          = $sortable[ $column_key ][2] ?? '';1466				$orderby_text  = $sortable[ $column_key ][3] ?? '';1467				$initial_order = $sortable[ $column_key ][4] ?? '';1468 1469				/*1470				 * We're in the initial view and there's no $_GET['orderby'] then check if the1471				 * initial sorting information is set in the sortable columns and use that.1472				 */1473				if ( '' === $current_orderby && $initial_order ) {1474					// Use the initially sorted column $orderby as current orderby.1475					$current_orderby = $orderby;1476					// Use the initially sorted column asc/desc order as initial order.1477					$current_order = $initial_order;1478				}1479 1480				/*1481				 * True in the initial view when an initial orderby is set via get_sortable_columns()1482				 * and true in the sorted views when the actual $_GET['orderby'] is equal to $orderby.1483				 */1484				if ( $current_orderby === $orderby ) {1485					// The sorted column. The `aria-sort` attribute must be set only on the sorted column.1486					if ( 'asc' === $current_order ) {1487						$order          = 'desc';

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