GF_Entry_List_Table
Class GF_Entry_List_Table
Since: 2.0
Source: entry_list.php:539
Details
- Kind:
class - Namespace:
(global) - Extends:
WP_List_Table
Properties
| Property | Type | Description |
|---|---|---|
$filter | string | The current filter e.g. trash, spam, unread |
$primary_column_name | null | string | The name of the primary column. The primary column will not get collapsed on narrower displays. |
$locking_info | GFEntryLocking | The locking mechanism for the entry list. |
$row_index | int | Tracks the cuurent row during output. |
Methods
| Method | Description |
|---|---|
__construct() | GF_Entry_List constructor. |
set_columns() | Set the hidden, sortable and primary columns. |
get_filter() | Returns the curent filter. |
get_form() | Returns the current form array. |
get_form_id() | Returns the current form ID. |
get_views() | Returns an associative array of views. |
get_filter_links() | Returns the array of filter links. |
get_order() | Gets the ordering for the entry list table. |
get_orderby() | Gets the column that list is ordered by. |
prepare_items() | Performs the search and prepares the entries for display. |
get_search_criteria() | Returns the array of search criteria. |
get_columns() | Returns the associative array of columns for the table. |
get_sortable_columns() | Returns the associative array of sortable columns for the table. |
column_cb() | Displays the checkbox column. |
column_column_selector() | Displays an empty cell for the column selector column. |
_column_is_starred() | Displays the is_starred row for the given entry. |
column_default() | Displays the entry value. |
get_detail_query_string() | Returns the entry detail query string. |
get_detail_url() | Returns the entry detail url. |
single_row() | Displays a single row. |
no_items() | Displays the no items message according to the context. |
get_primary_column_name() | Returns the name of the primary column. |
get_bulk_actions() | Returns the options for the bulk actions menu. |
bulk_actions() | Displays the bulk actions. |
process_action() | Processes a bulk or single action. |
extra_tablenav() | Displays additional fields required by FORM and displays the modals. |
output_scripts() | Output scripts |
modals() | Output modals. |
Method Reference
__construct()
public function __construct( $args=[] )
GF_Entry_List constructor.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$args | array | [] |
Source: entry_list.php:587
set_columns()
public function set_columns()
Set the hidden, sortable and primary columns.
Source: entry_list.php:614
get_filter()
public function get_filter()
Returns the curent filter.
Returns
string
Source: entry_list.php:627
get_form()
public function get_form()
Returns the current form array.
Returns
array
Source: entry_list.php:636
get_form_id()
public function get_form_id()
Returns the current form ID.
Returns
int
Source: entry_list.php:645
get_views()
function get_views()
Returns an associative array of views.
Returns
array
Source: entry_list.php:655
get_filter_links()
public function get_filter_links( $include_counts=true )
Returns the array of filter links.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$include_counts | bool | true |
Returns
array|mixed|void
Source: entry_list.php:688
get_order()
public function get_order()
Gets the ordering for the entry list table.
Also formats the query string to uppercase. If none is present, sets it to ascending.
Returns
string— The ordering to be used.
Since: 2.0.3.6
Source: entry_list.php:705
get_orderby()
public function get_orderby()
Gets the column that list is ordered by.
If none is set, defaults to 0 (the first column)
Returns
int— The column to be used.
Since: 2.0.3.6
Source: entry_list.php:719
prepare_items()
function prepare_items()
Performs the search and prepares the entries for display.
Source: entry_list.php:726
get_search_criteria()
function get_search_criteria()
Returns the array of search criteria.
Returns
array
Source: entry_list.php:795
get_columns()
function get_columns()
Returns the associative array of columns for the table.
Returns
array
Source: entry_list.php:865
get_sortable_columns()
function get_sortable_columns()
Returns the associative array of sortable columns for the table.
Returns
array
Source: entry_list.php:911
column_cb()
function column_cb( $entry )
Displays the checkbox column.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry | array |
Source: entry_list.php:925
column_column_selector()
function column_column_selector( $entry )
Displays an empty cell for the column selector column.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry |
Returns
string
Source: entry_list.php:941
_column_is_starred()
function _column_is_starred( $entry, $classes, $data, $primary )
Displays the is_starred row for the given entry.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry | |||
$classes | |||
$data | |||
$primary |
Source: entry_list.php:953
column_default()
function column_default( $entry, $column_id )
Displays the entry value.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry | object | ||
$column_id | string |
Source: entry_list.php:970
get_detail_query_string()
function get_detail_query_string( $entry )
Returns the entry detail query string.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry |
Returns
string
Source: entry_list.php:1090
get_detail_url()
function get_detail_url( $entry )
Returns the entry detail url.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry |
Returns
string|void
Source: entry_list.php:1123
single_row()
public function single_row( $entry )
Displays a single row.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry | array |
Source: entry_list.php:1135
no_items()
public function no_items()
Displays the no items message according to the context.
Source: entry_list.php:1149
get_primary_column_name()
function get_primary_column_name()
Returns the name of the primary column.
Returns
string
Source: entry_list.php:1347
get_bulk_actions()
function get_bulk_actions()
Returns the options for the bulk actions menu.
Returns
array
Source: entry_list.php:1363
bulk_actions()
function bulk_actions( $which='' )
Displays the bulk actions.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$which | string | '' |
Source: entry_list.php:1421
process_action()
function process_action()
Processes a bulk or single action.
Source: entry_list.php:1452
extra_tablenav()
function extra_tablenav( $which )
Displays additional fields required by FORM and displays the modals.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$which | string |
Source: entry_list.php:1601
output_scripts()
function output_scripts()
Output scripts
Source: entry_list.php:1618
modals()
public function modals()
Output modals.
Source: entry_list.php:2191