prepare_items() to handle any data manipulation, then
* finally call $yourInstance->display() to render the table to the page.
*
* Our theme for this list table is going to be movies.
*/
class WINP_Snippet_Library_Table extends WP_List_Table {
/** ************************************************************************
* Normally we would be querying data from a database and manipulating that
* for use in your list table. For this example, we're going to simplify it
* slightly and create a pre-built array. Think of this as the data that might
* be returned by $wpdb->query()
*
* In a real-world scenario, you would make your own custom query inside
* this class' prepare_items() method.
*
* @var array
**************************************************************************/
var $example_data = [];
/**
* Is modal window
*
* @var bool
*/
private $modal;
/**
* Если true, то выводить общие сниппеты без привязки к пользователю
*
* @var bool
*/
private $common;
/**
* @var array
*
* Array contains slug columns that you want hidden
*/
private $hidden_columns = [
'id',
];
/**
* @var integer
*/
private $per_page = 10;
/** ************************************************************************
* REQUIRED. Set up a constructor that references the parent constructor. We
* use the parent reference to set some default configs.
***************************************************************************/
/**
* WINP_Snippet_Library_Table constructor.
*
* @param bool $modal
*/
function __construct( $modal = false ) {
global $status, $page;
add_thickbox();
$this->modal = $modal;
$this->common = true;
// Set parent defaults
parent::__construct(
[
'singular' => 'snippet', // singular name of the listed records
'plural' => 'snippets', // plural name of the listed records
'ajax' => true, // does this table support ajax?
]
);
}
/** ************************************************************************
* Recommended. This method is called when the parent class can't find a method
* specifically build for a given column. Generally, it's recommended to include
* one method for each column you want to render, keeping your package class
* neat and organized. For example, if the class needs to process a column
* named 'title', it would first see if a method named $this->column_title()
* exists - if it does, that method will be used. If it doesn't, this one will
* be used. Generally, you should try to use custom column methods as much as
* possible.
*
* Since we have defined a column_title() method later on, this method doesn't
* need to concern itself with any column with a name of 'title'. Instead, it
* needs to handle everything else.
*
* For more detailed insight into how columns are handled, take a look at
* WP_List_Table::single_row_columns()
*
* @param array $item A singular item (one full row's worth of data)
* @param string $column_name The name/slug of the column to be processed
*
* @return string Text or HTML to be placed inside the column
';
case 'preview':
case 'datetime':
case 'insert':
case 'delete':
return $item[ $column_name ];
default:
return print_r( $item, true ); // Show the whole array for troubleshooting purposes
}
}
/** ************************************************************************
* Recommended. This is a custom column method and is responsible for what
* is rendered in any column with a name/slug of 'title'. Every time the class
* needs to render a column, it first looks for a method named
* column_{$column_title} - if it exists, that method is run. If it doesn't
* exist, column_default() is called instead.
*
* This example also illustrates how to implement rollover actions. Actions
* should be an associative array formatted as 'slug'=>'link html' - and you
* will need to generate the URLs yourself. You could even ensure the links
*
* @param array $item A singular item (one full row's worth of data)
*
* @return string Text to be placed inside the column
(movie title only)
* *************************************************************************@see WP_List_Table::::single_row_columns()
*/
public function column_title( $item ) {
// Build row actions
$actions = [/*
'edit' => sprintf( 'Edit', $_REQUEST['page'], 'edit', $item['ID'] ),
'delete' => sprintf( 'Delete', $_REQUEST['page'], 'delete', $item['ID'] ),*/
];
$url = admin_url() . 'post-new.php?post_type=' . WINP_SNIPPETS_POST_TYPE . '&winp_item=' . $item['type'] . '&snippet_id=' . $item['ID'] . ( $this->common ? '&common=1' : '' );
// Add premium badge if snippet is locked.
$premium_badge = '';
$is_locked = ! empty( $item['is_premium_locked'] );
if ( $is_locked ) {
$premium_badge = ' PRO';
}
// Return the title contents - no link for locked premium snippets.
if ( $is_locked ) {
return sprintf( '%1$s%2$s%3$s', /*$1%s*/ esc_html( $item['title'] ), /*$2%s*/ $premium_badge, /*$3%s*/ $this->row_actions( $actions ) );
}
return sprintf( '%2$s%3$s%4$s', /*$1%s*/ esc_url( $url ), /*$2%s*/ esc_html( $item['title'] ), /*$3%s*/ $premium_badge, /*$4%s*/ $this->row_actions( $actions ) );
}
/** ************************************************************************
* REQUIRED if displaying checkboxes or using bulk actions! The 'cb' column
* is given special treatment when columns are processed. It ALWAYS needs to
* have it's own method.
*
* @param array $item A singular item (one full row's worth of data)
*
* @return string Text to be placed inside the column
(movie title only)
* *************************************************************************@see WP_List_Table::::single_row_columns()
*/
public function column_cb( $item ) {
return sprintf(
'', /*$1%s*/
esc_attr( $this->_args['singular'] ), // Let's simply repurpose the table's singular label ("movie")
/*$2%s*/ esc_attr( $item['ID'] ) // The value of the checkbox should be the record's id
);
}
/** ************************************************************************
* REQUIRED! This method dictates the table's columns and titles. This should
* return an array where the key is the column slug (and class) and the value
* is the column's title text. If you need a checkbox for bulk actions, refer
* to the $columns array below.
*
* The 'cb' column is treated differently than the rest. If including a checkbox
* column in your table you must create a column_cb() method. If you don't need
* bulk actions or checkboxes, simply leave the 'cb' entry out of your array.
*
* @return array An associative array containing column information: 'slugs'=>'Visible Titles'
* *************************************************************************@see WP_List_Table::::single_row_columns()
*/
public function get_columns() {
$columns = [// 'cb' => '', //Render a checkbox instead of text
];
$columns['type'] = __( 'Type', 'insert-php' );
$columns['title'] = __( 'Title', 'insert-php' );
if ( ! $this->modal && $this->common ) {
$columns['preview'] = __( 'Preview', 'insert-php' );
}
$columns['desc'] = __( 'Description', 'insert-php' );
$columns['datetime'] = __( 'Date', 'insert-php' );
$columns['insert'] = __( 'Insert', 'insert-php' );
if ( ! $this->modal && ! $this->common ) {
$columns['delete'] = __( 'Delete', 'insert-php' );
}
return $columns;
}
/** ************************************************************************
* Optional. If you want one or more columns to be sortable (ASC/DESC toggle),
* you will need to register it here. This should return an array where the
* key is the column that needs to be sortable, and the value is db column to
* sort by. Often, the key and value will be the same, but this is not always
* the case (as the value is a column name from the database, not the list table).
*
* This method merely defines which columns should be sortable and makes them
* clickable - it does not handle the actual sorting. You still need to detect
* the ORDERBY and ORDER querystring variables within prepare_items() and sort
* your data accordingly (usually by modifying your query).
*
* @return array An associative array containing all the columns that should be sortable: 'slugs'=>array('data_values',bool)
**************************************************************************/
public function get_sortable_columns() {
$sortable_columns = [
'title' => [ 'title', false ], // true means it's already sorted
'type' => [ 'type', false ],
'datetime' => [ 'datetime', false ],
];
return $sortable_columns;
}
/** ************************************************************************
* Optional. If you need to include bulk actions in your list table, this is
* the place to define them. Bulk actions are an associative array in the format
* 'slug'=>'Visible Title'
*
* If this method returns an empty value, no bulk action will be rendered. If
* you specify any bulk actions, the bulk actions box will be rendered with
* the table automatically on display().
*
* Also note that list tables are not automatically wrapped in