Methods summary
public
|
|
public
|
#
prepare_items( )
Prepares the list of items for displaying
Prepares the list of items for displaying
|
public
|
#
views( )
Display the list of views available on this table
Display the list of views available on this table
|
protected
array
|
#
get_views( )
Get an associative array ( id => link ) with the list of views available on this table
Get an associative array ( id => link ) with the list of views available on this table
Returns
array
|
public
array
|
|
protected
array
|
#
getColumns( )
Get the saved table layout columns or the default layout
Get the saved table layout columns or the default layout
Returns
array
|
protected
boolean
|
#
filterMissingElement( string $column )
Filter any elements that do not exist from the columns
Filter any elements that do not exist from the columns
Parameters
Returns
boolean
|
public
string
|
#
getColumnLabel( string $column )
Get the label for the given column
Get the label for the given column
Parameters
Returns
string
|
protected
|
|
protected
array
|
#
getAllColumns( )
Get the list of all available columns
Get the list of all available columns
Returns
array
|
public
string
|
|
protected
string
|
#
get_default_primary_column_name( )
Gets the name of the default primary column
Gets the name of the default primary column
Returns
string
Name of the default primary column
|
protected
array
|
#
get_sortable_columns( )
Get the list of sortable columns
Get the list of sortable columns
Returns
array
|
public
|
#
single_row( array $item )
Generates content for a single row of the table
Generates content for a single row of the table
Parameters
|
protected
string
|
#
column_cb( array $item )
Get the checkbox column content for the given item
Get the checkbox column content for the given item
Parameters
Returns
string
|
protected
string
|
#
_column_icon( array $item, string $classes )
Get the icon column content for the given item
Get the icon column content for the given item
Parameters
- $item
- The current item
- $classes
- The cell classes
Returns
string
|
protected
string
|
#
_column_labels( array $item, string $classes )
Get the labels column content for the given item
Get the labels column content for the given item
Parameters
- $item
- The current item
- $classes
- The cell classes
Returns
string
|
protected
array|null
|
#
getLabelById( integer $id )
Get the label data by ID
Parameters
Returns
array|null
|
protected
string
|
#
handle_row_actions( array $item, string $column_name, string $primary )
Generates and display row actions links for the list table
Generates and display row actions links for the list table
Parameters
- $item
- The item being acted upon
- $column_name
- Current column name
- $primary
- Primary column name
Returns
string
The row actions HTML, or an empty string if the current column is not the primary column
|
protected
string
|
#
column_default( array $item, string $columnName )
Get the column cell content
Get the column cell content
Parameters
- $item
- The item being acted upon
- $columnName
- Current column name
Returns
string
|
protected
string
|
#
columnElement( array $item, string $columnName )
Get the column cell content for an element
Get the column cell content for an element
Parameters
- $item
- The item being acted upon
- $columnName
- Current column name
Returns
string
|
protected
array
|
#
get_bulk_actions( )
Get an associative array ( option_name => option_title ) with the list
of bulk actions available on this table
Get an associative array ( option_name => option_title ) with the list
of bulk actions available on this table
Returns
array
|
public
string
|
#
getLabelSearchHtml( )
Get the HTML for the label search
Get the HTML for the label search
Returns
string
|
protected
string
|
#
linkIfPrimaryColumn( string $output, array $item, string $columnName )
Wrap the given content in a link to view the entry if this column is the primary column
Wrap the given content in a link to view the entry if this column is the primary column
Parameters
- $output
- The current output for this column cell
- $item
- The entry item data
- $columnName
- The name of the column
Returns
string
|
public
|
#
no_items( )
Message to be displayed when there are no forms
Message to be displayed when there are no forms
|
public
|
#
search_box( string $text, string $input_id )
Displays the search box
Duplicate of the parent function, but still shows the search box if there are no items
Parameters
- $text
- The 'submit' button label.
- $input_id
- ID attribute value for the search input field.
|
protected
string
|
#
getOrderBy( string $requestedOrderBy = '' )
Get the order by value
Gets the user meta setting if a value is saved
Parameters
- $requestedOrderBy
- The requested order by from $_GET
Returns
string
|
protected
string
|
#
getOrder( string $requestedOrder = '' )
Get the order value ('asc' or 'desc')
Get the order value ('asc' or 'desc')
Gets the user meta setting if a value is saved
Parameters
- $requestedOrder
- The requested order from $_GET
Returns
string
|
Quform_Entry_List_Table