Content types Post Types: Admin Columns trait

Adds configurable columns to post type admin screens.

Capabilities and extension points

Provides post type admin list-table columns.

Cached normalized admin columns.

• var array|null

Registers post type admin-column hooks when columns are configured.

Gets normalized admin list-table column definitions.

A column may be a label string or an array containing label, callback, meta_key, taxonomy, before, after, position, allow_html, escape_callback, and sortable settings.

• return array Column definitions keyed by column name.

Normalizes one admin column definition.

• param string $name Column name.
• param mixed $column Column definition.
• return array|null Normalized definition, or null when invalid.

Adds configured columns to the post list table.

• param array $columns Existing list-table columns.
• return array Filtered list-table columns.

Inserts one column at its configured location.

• param array $columns Existing list-table columns.
• param string $name Column name.
• param array $column Column definition.
• return array Columns with the definition inserted.

Renders one configured admin column.

• param string $column_name Column name.
• param int $post_id Post ID.

Gets one admin column value.

• param string $column_name Column name.
• param int $post_id Post ID.
• param \WP_Post $post Post object.
• param array $column Column definition.
• return mixed Column value.

Resolves an admin column value callback.

Method names are resolved against the current definition object.

• param mixed $callback Configured callback.
• return callable|null Resolved callback.

Escapes one admin column value for output.

Set allow_html to true for wp_kses_post(), or provide escape_callback for another context-appropriate escaping function.

• param mixed $value Column value.
• param array $column Column definition.
• return string Escaped output.

Registers configured sortable admin columns.

• param array $columns Existing sortable columns.
• return array Filtered sortable columns.

Gets normalized sorting settings for one admin column.

Set sortable to true for automatic meta sorting, to a WordPress orderby value for native fields, or to an array for full control.

• param string $name Column name.
• param array $column Column definition.
• return array|null Sorting settings, or null when not sortable.

Applies sorting for a configured admin column.

• param \WP_Query $query Admin list-table query.

Applies normalized sorting settings to the admin query.

Override this method when a column requires a custom query strategy.

• param \WP_Query $query Admin list-table query.
• param string $name Column name.
• param array $sorting Sorting settings.

Adds an inclusive left join for metadata-backed admin sorting.

Posts without the configured metadata remain in the result set.

• param array $clauses Query SQL clauses.
• param \WP_Query $query Query object.
• return array Filtered SQL clauses.

Determines whether an admin query targets this post type.

• param \WP_Query $query Query object.
• return bool Whether the query targets this post type.

Source reference

This editable reference page is based on the PHP documentation in content-types/post-types/traits/trait-admin-columns.php.