_WP_List_Table_Compat
云策文档标注
概述
_WP_List_Table_Compat 是一个辅助类，专门用于向后兼容函数，继承自 WP_List_Table 类，用于管理列表表格的列信息。
关键要点
- 该类仅用于向后兼容函数，不应直接在新代码中使用。
- 提供构造函数以初始化屏幕对象和列数组，并自动添加过滤器。
- 包含 get_column_info 方法获取所有列、隐藏列、可排序列和主列信息。
- 包含 get_columns 方法返回存储的列数组。
代码示例
public function __construct( $screen, $columns = array() ) {
if ( is_string( $screen ) ) {
$screen = convert_to_screen( $screen );
}
$this->_screen = $screen;
if ( ! empty( $columns ) ) {
$this->_columns = $columns;
add_filter( 'manage_' . $screen->id . '_columns', array( $this, 'get_columns' ), 0 );
}
}注意事项
- 自 WordPress 3.1.0 版本引入，主要用于旧代码兼容。
- 继承自 WP_List_Table 类，位于 wp-admin/includes/class-wp-list-table.php。
原文内容
Helper class to be used only by back compat functions.
Methods
| Name | Description |
|---|---|
| _WP_List_Table_Compat::__construct | Constructor. |
| _WP_List_Table_Compat::get_column_info | Gets a list of all, hidden, and sortable columns. |
| _WP_List_Table_Compat::get_columns | Gets a list of columns. |
Source
class _WP_List_Table_Compat extends WP_List_Table {
public $_screen;
public $_columns;
/**
* Constructor.
*
* @since 3.1.0
*
* @param string|WP_Screen $screen The screen hook name or screen object.
* @param string[] $columns An array of columns with column IDs as the keys
* and translated column names as the values.
*/
public function __construct( $screen, $columns = array() ) {
if ( is_string( $screen ) ) {
$screen = convert_to_screen( $screen );
}
$this->_screen = $screen;
if ( ! empty( $columns ) ) {
$this->_columns = $columns;
add_filter( 'manage_' . $screen->id . '_columns', array( $this, 'get_columns' ), 0 );
}
}
/**
* Gets a list of all, hidden, and sortable columns.
*
* @since 3.1.0
*
* @return array
*/
protected function get_column_info() {
$columns = get_column_headers( $this->_screen );
$hidden = get_hidden_columns( $this->_screen );
$sortable = array();
$primary = $this->get_default_primary_column_name();
return array( $columns, $hidden, $sortable, $primary );
}
/**
* Gets a list of columns.
*
* @since 3.1.0
*
* @return array
*/
public function get_columns() {
return $this->_columns;
}
}
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |