WP_List_Table::get_primary_column_name(): string

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

string

The name of the primary column.

Performance profile

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

24–29

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

Plugin surface

1 hook

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

Called by

2

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

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

1. 1
   apply_filters( list_table_primary_column )filterline 1287 (+20 into the body)

   Filters the name of the primary column for the current list table.

Uses · 3

• get_column_headers()Get the column headers for a screen
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_List_Table::get_default_primary_column_name()Gets the name of the default primary column.

Used by · 2

• WP_List_Table::get_column_info()Gets a list of all, hidden, and sortable columns, with filter applied.
• WP_List_Table::get_primary_column()Gets the name of the primary column.

Source code

View on Trac ↗View on GitHub ↗

1267	protected function get_primary_column_name() {1268		$columns = get_column_headers( $this->screen );1269		$default = $this->get_default_primary_column_name();1270 1271		/*1272		 * If the primary column doesn't exist,1273		 * fall back to the first non-checkbox column.1274		 */1275		if ( ! isset( $columns[ $default ] ) ) {1276			$default = self::get_default_primary_column_name();1277		}1278 1279		/**1280		 * Filters the name of the primary column for the current list table.1281		 *1282		 * @since 4.3.01283		 *1284		 * @param string $default Column name default for the specific list table, e.g. 'name'.1285		 * @param string $context Screen ID for specific list table, e.g. 'plugins'.1286		 */1287		$column = apply_filters( 'list_table_primary_column', $default, $this->screen->id );1288 1289		if ( empty( $column ) || ! isset( $columns[ $column ] ) ) {1290			$column = $default;1291		}1292 1293		return $column;1294	}

Changelog

Introduced in 4.3.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 6.9.7 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.