WP_List_Table::get_primary_column_name() │ protected │ WP 4.3.0

Gets the name of the primary column.

Method of the class: WP_List_Table{}

Return

String. The name of the primary column.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_primary_column_name();

Changelog

WP_List_Table::get_primary_column_name() WP List Table::get primary column name code ^{WP 6.5.2}

protected function get_primary_column_name() {
	$columns = get_column_headers( $this->screen );
	$default = $this->get_default_primary_column_name();

	/*
	 * If the primary column doesn't exist,
	 * fall back to the first non-checkbox column.
	 */
	if ( ! isset( $columns[ $default ] ) ) {
		$default = self::get_default_primary_column_name();
	}

	/**
	 * Filters the name of the primary column for the current list table.
	 *
	 * @since 4.3.0
	 *
	 * @param string $default Column name default for the specific list table, e.g. 'name'.
	 * @param string $context Screen ID for specific list table, e.g. 'plugins'.
	 */
	$column = apply_filters( 'list_table_primary_column', $default, $this->screen->id );

	if ( empty( $column ) || ! isset( $columns[ $column ] ) ) {
		$column = $default;
	}

	return $column;
}