plugin = $plugin;
$screen_id = isset( $args['screen'] ) ? $args['screen'] : null;
/**
* Filter the list table screen ID
*
* @return string
*/
$screen_id = apply_filters( 'wp_stream_list_table_screen_id', $screen_id );
parent::__construct(
array(
'post_type' => 'stream',
'plural' => 'records',
'screen' => $screen_id,
)
);
add_screen_option(
'per_page',
array(
'default' => 20,
'label' => __( 'Records per page', 'stream' ),
'option' => 'edit_stream_per_page',
)
);
// Check for default hidden columns.
$this->get_hidden_columns();
add_filter(
'screen_settings',
array(
$this,
'screen_controls',
),
10,
2
);
add_filter(
'set-screen-option',
array(
$this,
'set_screen_option',
),
10,
3
);
set_screen_options();
}
/**
* Renders extra from navigation options.
*
* @param string $which Page location.
* @return void
*/
public function extra_tablenav( $which ) {
if ( 'top' === $which ) {
echo $this->filters_form(); // xss ok.
}
}
/**
* Renders "No items found" message.
*
* @return void
*/
public function no_items() {
?>
__( 'Date', 'stream' ),
'summary' => __( 'Summary', 'stream' ),
'user_id' => __( 'User', 'stream' ),
'context' => __( 'Context', 'stream' ),
'action' => __( 'Action', 'stream' ),
'ip' => __( 'IP Address', 'stream' ),
)
);
}
/**
* Returns the columns the items can be sort by.
*
* @return array
*/
public function get_sortable_columns() {
return array(
'date' => array( 'date', false ),
);
}
/**
* Returns columns hidden from all except specific users.
*
* @return array|bool
*/
public function get_hidden_columns() {
$user = wp_get_current_user();
if ( ! $user ) {
return array();
}
// Directly checking the user meta; to check whether user has changed screen option or not.
$hidden = $this->plugin->admin->get_user_meta( $user->ID, 'manage' . $this->screen->id . 'columnshidden', true );
// If user meta is not found; add the default hidden column 'id'.
if ( ! $hidden ) {
$hidden = array( 'id' );
$this->plugin->admin->update_user_meta( $user->ID, 'manage' . $this->screen->id . 'columnshidden', $hidden );
}
return $hidden;
}
/**
* Prepares table columns and data for render
*
* @return void
*/
public function prepare_items() {
$columns = $this->get_columns();
$sortable = $this->get_sortable_columns();
$hidden = $this->get_hidden_columns();
$primary = $columns['summary'];
$this->_column_headers = array(
$columns,
$hidden,
$sortable,
$primary,
);
$this->items = $this->get_records();
$total_items = $this->get_total_found_rows();
$this->set_pagination_args(
array(
'total_items' => $total_items,
'per_page' => $this->get_items_per_page( 'edit_stream_per_page', 20 ),
)
);
}
/**
* Returns records to be displayed
*
* @return array
*/
public function get_records() {
$args = array();
// Parse sorting params.
$order = wp_stream_filter_input( INPUT_GET, 'order' );
if ( $order ) {
$args['order'] = $order;
}
$orderby = wp_stream_filter_input( INPUT_GET, 'orderby' );
if ( $orderby ) {
$args['orderby'] = $orderby;
}
$params = array(
'search',
'date',
'date_from',
'date_to',
'date_after',
'date_before',
);
foreach ( $params as $param ) {
$value = wp_stream_filter_input( INPUT_GET, $param );
if ( $value ) {
$args[ $param ] = $value;
}
}
// Additional filter properties.
$properties = array(
'record',
'site_id',
'blog_id',
'object_id',
'user_id',
'user_role',
'ip',
'connector',
'context',
'action',
);
// Add property fields to defaults, including their __in/__not_in variations.
foreach ( $properties as $property ) {
$value = wp_stream_filter_input( INPUT_GET, $property );
// Allow 0 values.
if ( isset( $value ) && '' !== $value && false !== $value ) {
$args[ $property ] = $value;
}
$value_in = wp_stream_filter_input( INPUT_GET, $property . '__in' );
if ( $value_in ) {
$args[ $property . '__in' ] = explode( ',', $value_in );
}
$value_not_in = wp_stream_filter_input( INPUT_GET, $property . '__not_in' );
if ( $value_not_in ) {
$args[ $property . '__not_in' ] = explode( ',', $value_not_in );
}
}
$args['paged'] = $this->get_pagenum();
if ( isset( $args['context'] ) && 0 === strpos( $args['context'], 'group-' ) ) {
$args['connector'] = str_replace( 'group-', '', $args['context'] );
$args['context'] = '';
}
if ( ! isset( $args['records_per_page'] ) ) {
$args['records_per_page'] = $this->get_items_per_page( 'edit_stream_per_page', 20 );
}
$args['records_per_page'] = apply_filters( 'stream_records_per_page', $args['records_per_page'] );
$items = $this->plugin->db->get_records( $args );
return $items;
}
/**
* Get last query found rows
*
* @return integer
*/
public function get_total_found_rows() {
return $this->plugin->db->get_found_records_count();
}
/**
* Returns the column content for the provided item and column.
*
* @param array $item Record data.
* @param string $column_name Column name.
* @return void
*/
public function column_default( $item, $column_name ) {
$out = '';
$record = new Record( $item );
switch ( $column_name ) {
case 'date':
$created = gmdate( 'Y-m-d H:i:s', strtotime( $record->created ) );
$date_string = sprintf(
'',
wp_stream_get_iso_8601_extended_date( strtotime( $record->created ) ),
get_date_from_gmt( $created, 'Y/m/d' )
);
$out = $this->column_link( $date_string, 'date', get_date_from_gmt( $created, 'Y/m/d' ) );
$out .= '
';
$out .= get_date_from_gmt( $created, 'h:i:s A' );
break;
case 'summary':
$out = $record->summary;
$object_title = $record->get_object_title();
/* translators: %s: the title of any object, like a Post (e.g. "Hello World") */
$view_all_text = $object_title ? sprintf( esc_html__( 'View all activity for "%s"', 'stream' ), esc_attr( $object_title ) ) : esc_html__( 'View all activity for this object', 'stream' );
if ( $record->object_id ) {
$out .= $this->column_link(
'',
array(
'object_id' => $record->object_id,
'context' => $record->context,
),
null,
esc_attr( $view_all_text )
);
}
$out .= $this->get_action_links( $record );
break;
case 'user_id':
$user = new Author( (int) $record->user_id, (array) $record->user_meta );
$filtered_records_url = add_query_arg(
array(
'page' => $this->plugin->admin->records_page_slug,
'user_id' => absint( $user->id ),
),
self_admin_url( $this->plugin->admin->admin_parent_page )
);
$out = sprintf(
'%s %s%s%s%s',
$filtered_records_url,
$user->get_avatar_img( 80 ),
$user->get_display_name(),
$user->is_deleted() ? sprintf( '
%s', esc_html__( 'Deleted User', 'stream' ) ) : '',
sprintf( '
%s', $user->get_role() ),
sprintf( '
%s', $user->get_agent_label( $user->get_agent() ) )
);
break;
case 'context':
$connector_title = $this->get_term_title( $record->{'connector'}, 'connector' );
$context_title = $this->get_term_title( $record->{'context'}, 'context' );
$out = $this->column_link( $connector_title, 'connector', $item->{'connector'} );
$out .= '
↳ ';
$out .= $this->column_link(
$context_title,
array(
'connector' => $record->{'connector'},
'context' => $record->{'context'},
)
);
break;
case 'action':
$out = $this->column_link( $this->get_term_title( $record->{$column_name}, $column_name ), $column_name, $record->{$column_name} );
break;
case 'blog_id':
$blog = ( $record->blog_id && is_multisite() ) ? get_blog_details( $record->blog_id ) : $this->plugin->admin->network->get_network_blog();
$out = $this->column_link( $blog->blogname, 'blog_id', $blog->blog_id );
break;
case 'ip':
$out = $this->column_link( $record->{$column_name}, 'ip', $record->{$column_name} );
break;
default:
/**
* Registers new Columns to be inserted into the table. The cell contents of this column is set
* below with 'wp_stream_insert_column_default_'
*
* @param array $new_columns Columns injected in the table.
*
* @return array
*/
$inserted_columns = apply_filters( 'wp_stream_register_column_defaults', array() );
if ( ! empty( $inserted_columns ) && is_array( $inserted_columns ) ) {
foreach ( $inserted_columns as $column_title ) {
/**
* If column title inserted via wp_stream_register_column_defaults ($column_title) exists
* among columns registered with get_columns ($column_name) and there is an action associated
* with this column, do the action
*
* Also, note that the action name must include the $column_title registered
* with wp_stream_register_column_defaults
*/
if ( $column_title === $column_name ) {
/**
* Allows for the addition of content under a specified column.
*
* @param string $out Column content.
* @param object $record Record with row content.
* @param string $column_name Column name.
*
* @return string
*/
$out = apply_filters( "wp_stream_insert_column_default_{$column_title}", $out, $record, $column_name );
break;
}
}
}
}
$allowed_tags = wp_kses_allowed_html( 'post' );
$allowed_tags['time'] = array(
'datetime' => true,
'class' => true,
);
$allowed_tags['img']['srcset'] = true;
echo wp_kses( $out, $allowed_tags );
}
/**
* Returns the actions links for the provided record. (Eg. Edit, View)
*
* @param Record $record Record.
* @return string
*/
public function get_action_links( $record ) {
$out = '';
/**
* Filter allows modification of action links for a specific connector
*
* @param array
* @param Record
*
* @return array Action links for this connector
*/
$action_links = apply_filters( 'wp_stream_action_links_' . $record->connector, array(), $record );
/**
* Filter allows addition of custom links for a specific connector
*
* @param array
* @param Record
*
* @return array Custom links for this connector
*/
$custom_links = apply_filters( 'wp_stream_custom_action_links_' . $record->connector, array(), $record );
if ( $action_links || $custom_links ) {
$out .= '';
}
$links = array();
if ( $action_links && is_array( $action_links ) ) {
foreach ( $action_links as $al_title => $al_href ) {
$links[] = sprintf(
'
%s',
$al_href,
$al_title
);
}
}
if ( $custom_links && is_array( $custom_links ) ) {
foreach ( $custom_links as $key => $link ) {
$links[] = $link;
}
}
$out .= implode( ' | ', $links );
if ( $action_links || $custom_links ) {
$out .= '
%s
', $filters_string ); // xss ok.
}
/**
* Returns HTML string of filterable select control with filtered items.
*
* @param string $name Search input.
* @param string $title Name of the control.
* @param array $items Items to be filtered.
* @param boolean $ajax Whether is an ajax request or not.
* @return string
*/
public function filter_select( $name, $title, $items, $ajax = false ) {
$options = array( '' );
$selected = wp_stream_filter_input( INPUT_GET, $name );
foreach ( $items as $key => $item ) {
$value = isset( $item['children'] ) ? 'group-' . $key : $key;
$option_args = array(
'value' => $value,
'selected' => selected( $value, $selected, false ),
'disabled' => isset( $item['disabled'] ) ? $item['disabled'] : null,
'icon' => isset( $item['icon'] ) ? $item['icon'] : null,
'group' => isset( $item['children'] ) ? $key : null,
'tooltip' => isset( $item['tooltip'] ) ? $item['tooltip'] : null,
'class' => isset( $item['children'] ) ? 'level-1' : null,
'label' => isset( $item['label'] ) ? $item['label'] : null,
);
$options[] = $this->filter_option( $option_args );
if ( isset( $item['children'] ) ) {
foreach ( $item['children'] as $child_value => $child_item ) {
$option_args = array(
'value' => $child_value,
'selected' => selected( $child_value, $selected, false ),
'disabled' => isset( $child_item['disabled'] ) ? $child_item['disabled'] : null,
'icon' => isset( $child_item['icon'] ) ? $child_item['icon'] : null,
'group' => $key,
'tooltip' => isset( $child_item['tooltip'] ) ? $child_item['tooltip'] : null,
'class' => 'level-2',
'label' => isset( $child_item['label'] ) ? '- ' . $child_item['label'] : null,
);
$options[] = $this->filter_option( $option_args );
}
}
}
$out = sprintf(
'',
esc_attr( $name ),
/* translators: %s: the title of the dropdown menu (e.g. "users") */
sprintf( esc_attr__( 'Show all %s', 'stream' ), $title ),
implode( '', $options )
);
return $out;
}
/**
* Return HTML string of a filterable select option.
*
* @param array $args Option attributes.
* @return string
*/
public function filter_option( $args ) {
$defaults = array(
'value' => null,
'selected' => null,
'disabled' => null,
'icon' => null,
'group' => null,
'tooltip' => null,
'class' => null,
'label' => null,
);
wp_parse_args( $args, $defaults );
return sprintf(
'',
esc_attr( $args['value'] ),
$args['selected'],
$args['disabled'],
$args['icon'] ? sprintf( 'data-icon="%s"', esc_attr( $args['icon'] ) ) : null,
$args['group'] ? sprintf( 'data-group="%s"', esc_attr( $args['group'] ) ) : null,
$args['tooltip'] ? sprintf( 'title="%s"', esc_attr( $args['tooltip'] ) ) : null,
$args['class'] ? esc_attr( $args['class'] ) : null,
esc_html( $args['label'] )
);
}
/**
* Return HTML string of a filter search box.
*
* @return string
*/
public function filter_search() {
$search = null;
if ( isset( $_GET['search'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$search = sanitize_key( wp_unslash( $_GET['search'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
}
$out = sprintf(
'
',
esc_attr__( 'Search Records', 'stream' ),
$search
);
return $out;
}
/**
* Return HTML string of a filter select box based upon date.
*
* @param array $items Records.
* @return string
*/
public function filter_date( $items ) {
wp_enqueue_style( 'jquery-ui' );
wp_enqueue_style( 'wp-stream-datepicker' );
wp_enqueue_script( 'jquery-ui-datepicker' );
$date_predefined = wp_stream_filter_input( INPUT_GET, 'date_predefined' );
$date_from = wp_stream_filter_input( INPUT_GET, 'date_from' );
$date_to = wp_stream_filter_input( INPUT_GET, 'date_to' );
ob_start();
?>
'Action Name'
*/
$actions = apply_filters( 'wp_stream_record_actions_menu', array() );
if ( empty( $actions ) ) {
return '';
}
ob_start();
printf( '';
wp_nonce_field( 'stream_record_actions_nonce', 'stream_record_actions_nonce' );
wp_nonce_field( 'stream_filters_user_search_nonce', 'stream_filters_user_search_nonce' );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'page' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'date_predefined' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'date_from' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'date_to' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'user_id' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'connector' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'context' ) ) );
printf( '', esc_attr( wp_stream_filter_input( INPUT_GET, 'action' ) ) );
printf( '', esc_attr__( 'Apply', 'stream' ) );
echo '';
return ob_get_clean();
}
/**
* Renders record filter forms.
*/
public function display() {
$url = self_admin_url( $this->plugin->admin->admin_parent_page );
echo '';
echo '';
}
/**
* Renders a single record
*
* @param array $item Record data.
*/
public function single_row( $item ) {
$classes = apply_filters( 'wp_stream_record_classes', array(), $item );
$class_string = '';
if ( ! empty( $classes ) ) {
$class_string = ' class="' . esc_attr( join( ' ', $classes ) ) . '"';
}
echo sprintf( '', $class_string ); // xss ok.
$this->single_row_columns( $item );
echo '';
}
/**
* Renders table navigation controls
*
* @param string $which Location controls.
*/
public function display_tablenav( $which ) {
if ( 'top' === $which ) :
?>
pagination( $which );
$this->extra_tablenav( $which );
?>
pagination( $which );
$this->extra_tablenav( $which );
?>
plugin->admin->live_update->user_meta_key === $option
&&
isset( $_POST[ $this->plugin->admin->live_update->user_meta_key ] )
) {
$value = esc_attr( $_POST[ $this->plugin->admin->live_update->user_meta_key ] ); //input var okay
return $value;
}
// @codingStandardsIgnoreEnd
return $dummy;
}
/**
* Return HTML string of the "Live updates" screen option.
*
* @param string $status Unused.
* @param array $args Unused.
* @return string
*/
public function screen_controls( $status, $args ) {
unset( $status );
unset( $args );
$user_id = get_current_user_id();
$option = $this->plugin->admin->get_user_meta( $user_id, $this->plugin->admin->live_update->user_meta_key, true );
$heartbeat = wp_script_is( 'heartbeat', 'done' ) ? 'true' : 'false';
if ( 'on' === $option && 'false' === $heartbeat ) {
$option = 'off';
$this->plugin->admin->update_user_meta( $user_id, $this->plugin->admin->live_update->user_meta_key, 'off' );
}
$nonce = wp_create_nonce( $this->plugin->admin->live_update->user_meta_key . '_nonce' );
ob_start();
?>
$args ) {
$user = new Author( $user_id );
$disabled = isset( $args['disabled'] ) ? $args['disabled'] : null;
$record_meta[ $user_id ] = array(
'text' => $user->get_display_name(),
'id' => $user_id,
'label' => $user->get_display_name(),
'icon' => $user->get_avatar_src( 32 ),
'title' => '',
'disabled' => $disabled,
);
}
return $record_meta;
}
}