[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress Opt-outs List Table class.

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

Defines 1 class

BP_Optouts_List_Table:: (19 methods):
  __construct()
  prepare_items()
  get_default_primary_column_name()
  views()
  extra_tablenav()
  get_columns()
  get_bulk_actions()
  no_items()
  get_sortable_columns()
  display_rows()
  single_row()
  column_cb()
  column_email_address()
  column_username()
  column_user_registered()
  column_email_type()
  column_email_type_description()
  column_optout_date_modified()
  column_default()


Class: BP_Optouts_List_Table  - X-Ref

List table class for nonmember opt-outs admin page.

__construct()   X-Ref
Constructor.

since: 8.0.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: 8.0.0

get_default_primary_column_name()   X-Ref
Gets the name of the default primary column.

since: 10.1.0
return: string Name of the default primary column, in this case, 'email_address'.

views()   X-Ref
Get the list of views available on this table.

since: 8.0.0

extra_tablenav( $which )   X-Ref
Get rid of the extra nav.

WP_Users_List_Table will add an extra nav to change user's role.
As we're dealing with opt-outs, we don't need this.

param: array $which Current table nav item.
since: 8.0.0

get_columns()   X-Ref
Specific opt-out columns.

since: 8.0.0
return: array

get_bulk_actions()   X-Ref
Specific bulk actions for opt-outs.

since: 8.0.0

no_items()   X-Ref
The text shown when no items are found.

Nice job, clean sheet!

since: 8.0.0

get_sortable_columns()   X-Ref
The columns opt-outs can be reordered by.

since: 8.0.0

display_rows()   X-Ref
Display opt-out rows.

since: 8.0.0

single_row( $optout = null, $style = '', $role = '', $numposts = 0 )   X-Ref
Display an opt-out row.

param: BP_Optout $optout   BP_Optout object.
param: string    $style    Styles for the row.
param: string    $role     Role to be assigned to user.
param: int       $numposts Number of posts.
since: 8.0.0
return: void

column_cb( $optout = null )   X-Ref
Markup for the checkbox used to select items for bulk actions.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_email_address( $optout = null )   X-Ref
Markup for the checkbox used to select items for bulk actions.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_username( $optout = null )   X-Ref
The inviter/site member who sent the email that prompted the opt-out.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_user_registered( $optout = null )   X-Ref
Display registration date of user whose communication prompted opt-out.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_email_type( $optout = null )   X-Ref
Display type of email that prompted opt-out.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_email_type_description( $optout = null )   X-Ref
Display description of bp-email-type that prompted opt-out.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_optout_date_modified( $optout = null )   X-Ref
Display opt-out date.

param: BP_Optout $optout BP_Optout object.
since: 8.0.0

column_default( $optout = null, $column_name = '' )   X-Ref
Allow plugins to add custom columns.

param: BP_Optout $optout      BP_Optout object.
param: string    $column_name The column name.
since: 8.0.0
return: string



Generated: Sat Apr 27 01:00:55 2024 Cross-referenced by PHPXref 0.7.1