[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-groups/classes/ -> class-bp-groups-list-table.php (summary)

BuddyPress Groups admin list table class. Props to WordPress core for the Comments admin screen, and its contextual help text, on which this implementation is heavily based.

File Size: 801 lines (24 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_Groups_List_Table:: (25 methods):
  __construct()
  prepare_items()
  get_column_info()
  get_default_primary_column_name()
  no_items()
  display()
  extra_tablenav()
  single_row()
  get_views()
  get_bulk_actions()
  get_columns()
  get_sortable_columns()
  row_actions()
  column_cb()
  column_gid()
  column_comment()
  column_description()
  column_status()
  column_members()
  column_last_active()
  column_default()
  add_type_column()
  column_content_group_type()
  group_type_permalink_use_admin_filter()
  add_group_type_bulk_change_select()


Class: BP_Groups_List_Table  - X-Ref

List table class for the Groups component admin page.

__construct()   X-Ref
Constructor

since: 1.7.0

prepare_items()   X-Ref
Set up items for display in the list table.

Handles filtering of data, sorting, pagination, and any other data
manipulation required prior to rendering.

since: 1.7.0

get_column_info()   X-Ref
Get an array of all the columns on the page.

return: array Array of column headers.
since: 1.7.0

get_default_primary_column_name()   X-Ref
Get name of default primary column

return: string
since: 2.3.3

no_items()   X-Ref
Display a message on screen when no items are found ("No groups found").

since: 1.7.0

display()   X-Ref
Output the Groups data table.

since: 1.7.0

extra_tablenav( $which )   X-Ref
Extra controls to be displayed between bulk actions and pagination

param: string $which
since: 2.7.0

single_row( $item = array()   X-Ref
Generate content for a single row of the table.

param: object|array $item The current group item in the loop.
since: 1.7.0

get_views()   X-Ref
Get the list of views available on this table (e.g. "all", "public").

since: 1.7.0

get_bulk_actions()   X-Ref
Get bulk actions for single group row.

return: array Key/value pairs for the bulk actions dropdown.
since: 1.7.0

get_columns()   X-Ref
Get the table column titles.

return: array Array of column titles.
since: 1.7.0

get_sortable_columns()   X-Ref
Get the column names for sortable columns.

Note: It's not documented in WP, but the second item in the
nested arrays below is $desc_first. Normally, we would set
last_active to be desc_first (since you're generally interested in
the *most* recently active group, not the *least*). But because
the default sort for the Groups admin screen is DESC by last_active,
we want the first click on the Last Active column header to switch
the sort order - ie, to make it ASC. Thus last_active is set to
$desc_first = false.

return: array Array of sortable column names.
since: 1.7.0

row_actions( $actions, $always_visible = false )   X-Ref
Override WP_List_Table::row_actions().

Basically a duplicate of the row_actions() method, but removes the
unnecessary <button> addition.

return: string
param: array $actions        The list of actions.
param: bool  $always_visible Whether the actions should be always visible.
since: 2.3.3
since: 2.3.4 Visibility set to public for compatibility with WP < 4.0.0.

column_cb( $item = array()   X-Ref
Markup for the Checkbox column.

param: array $item A singular item (one full row).
since: 1.7.0

column_gid( $item = array()   X-Ref
Markup for the Group ID column.

param: array $item A singular item (one full row).
since: 1.7.0

column_comment( $item = array()   X-Ref
Name column, and "quick admin" rollover actions.

Called "comment" in the CSS so we can re-use some WP core CSS.

param: array $item A singular item (one full row).
since: 1.7.0

column_description( $item = array()   X-Ref
Markup for the Description column.

param: array $item Information about the current row.
since: 1.7.0

column_status( $item = array()   X-Ref
Markup for the Status column.

param: array $item Information about the current row.
since: 1.7.0

column_members( $item = array()   X-Ref
Markup for the Number of Members column.

param: array $item Information about the current row.
since: 1.7.0

column_last_active( $item = array()   X-Ref
Markup for the Last Active column.

param: array $item Information about the current row.
since: 1.7.0

column_default( $item = array()   X-Ref
Allow plugins to add their custom column.

return: string
param: array  $item        Information about the current row.
param: string $column_name The column name.
since: 2.0.0

add_type_column( $columns = array()   X-Ref
Add group type column to the WordPress admin groups list table.

return: array $columns
param: array $columns Groups table columns.
since: 2.7.0

column_content_group_type( $retval = '', $column_name, $item )   X-Ref
Markup for the Group Type column.

return: string
param: string $retval      Empty string.
param: string $column_name Name of the column being rendered.
param: array  $item        The current group item in the loop.
since: 2.7.0

group_type_permalink_use_admin_filter( $retval, $type )   X-Ref
Filters the group type list permalink in the Group Type column.

Changes the group type permalink to use the admin URL.

return: string
param: string $retval Current group type permalink.
param: object $type   Group type object.
since: 2.7.0

add_group_type_bulk_change_select( $which )   X-Ref
Markup for the Group Type bulk change select.

param: string $which The location of the extra table nav markup: 'top' or 'bottom'.
since: 2.7.0



Generated: Mon Oct 21 01:01:35 2019 Cross-referenced by PHPXref 0.7.1