PHP Class WPDKListTableModel

Since: 1.4.13
Author: =undo= ([email protected])
Inheritance: implements IWPDKListTableModel
Datei anzeigen Open project: wpxtreme/wpdk Class Usage Examples

Public Properties

Property Type Description
$action_result boolean Used for check the action and bulk action results.

Public Methods

Method Description
__construct ( ) : WPDKListTableModel Create an instance of WPDKListTableModel class
action_result ( boolean | WP_Error $result ) Set the action result.
current_action ( $nonce = '' ) : string | boolean Get the current action selected from the bulk actions dropdown.
get_actions_with_status ( array $item, array $status ) : array Return tha array with the row actions for the current status.
get_bulk_actions_with_status ( string $status ) : array Return the array with the buk action for the combo menu for a status of view
get_columns ( ) : array Return a key value pairs array with the list of columns
get_count_statuses ( ) : array Return a key value pairs array with status key => count.
get_icon_statuses ( ) : array Return a key value pairs array with statuses icons glyph
get_sortable_columns ( ) : array Return the sortable columns
get_statuses ( ) : array Return a key value pairs array with statuses supported
process_bulk_action ( ) Process actions. Override when you need to process actions before wp is loaded.
select ( ) Return the items array. This is an array of key value pairs array

Method Details

__construct() public method

Create an instance of WPDKListTableModel class
public __construct ( ) : WPDKListTableModel
return WPDKListTableModel

action_result() public method

Set the action result.
Since: 1.6.0
public action_result ( boolean | WP_Error $result )
$result boolean | WP_Error A result from an "action".

current_action() public method

Get the current action selected from the bulk actions dropdown.
public current_action ( $nonce = '' ) : string | boolean
return string | boolean The action name or False if no action was selected

get_actions_with_status() public method

Return tha array with the row actions for the current status.
public get_actions_with_status ( array $item, array $status ) : array
$item array The item
$status array Describe one or more status of single item
return array

get_bulk_actions_with_status() public method

Return the array with the buk action for the combo menu for a status of view
public get_bulk_actions_with_status ( string $status ) : array
$status string Current status. Usually this is the status in the URI, when user select 'All', 'Publish', etc...
return array

get_columns() public method

Return a key value pairs array with the list of columns
public get_columns ( ) : array
return array

get_count_statuses() public method

Return a key value pairs array with status key => count.
Since: 1.5.16
public get_count_statuses ( ) : array
return array

get_icon_statuses() public method

Return a key value pairs array with statuses icons glyph
public get_icon_statuses ( ) : array
return array

get_sortable_columns() public method

Return the sortable columns
public get_sortable_columns ( ) : array
return array

get_statuses() public method

Return a key value pairs array with statuses supported
public get_statuses ( ) : array
return array

process_bulk_action() public method

Process actions. Override when you need to process actions before wp is loaded.
Since: 1.4.21
public process_bulk_action ( )

select() public method

Return the items array. This is an array of key value pairs array
public select ( )

Property Details

$action_result public_oe property

Used for check the action and bulk action results.
public bool $action_result
return boolean