BBP_Topic_Replies_List_Table

Topic replies list table


Description Description

This list table is responsible for showing the replies to a topic in a meta-box, similar to comments in posts and pages.


Source Source

File: includes/admin/classes/class-bbp-topic-replies-list-table.php

class BBP_Topic_Replies_List_Table extends WP_List_Table {

	/**
	 * The main constructor method
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function __construct( $args = array() ) {

		// Parse arguments
		$args = bbp_parse_args( $args, array(
			'singular' => 'reply',
			'plural'   => 'replies',
			'ajax'     => false
		), 'topic_replies_list_table' );

		// Construct the list table
		parent::__construct( $args );	}

	/**
	 * Setup the list-table columns
	 *
	 * @since 2.6.0 bbPress (r5886)
	 *
	 * @see WP_List_Table::::single_row_columns()
	 *
	 * @return array An associative array containing column information
	 */
	public function get_columns() {
		return array(
			//'cb'                 => '<input type="checkbox" />',
			'bbp_topic_reply_author' => esc_html__( 'Author',  'bbpress' ),
			'bbp_reply_content'      => esc_html__( 'Content', 'bbpress' ),
			'bbp_reply_created'      => esc_html__( 'Replied', 'bbpress' ),
		);
	}

	/**
	 * Allow `bbp_reply_created` to be sortable
	 *
	 * @since 2.6.0 bbPress (r5886)
	 *
	 * @return array An associative array containing the `bbp_reply_created` column
	 */
	public function get_sortable_columns() {
		return array(
			'bbp_reply_created' => array( 'bbp_reply_created', false )
		);
	}

	/**
	 * Setup the bulk actions
	 *
	 * @since 2.6.0 bbPress (r5886)
	 *
	 * @return array An associative array containing all the bulk actions
	 */
	public function get_bulk_actions() {
		return array();

		// @todo cap checks
		return array(
			'unapprove' => esc_html__( 'Unapprove', 'bbpress' ),
			'spam'      => esc_html__( 'Spam',      'bbpress' ),
			'trash'     => esc_html__( 'Trash',     'bbpress' )
		);
	}

	/**
	 * Output the check-box column for bulk actions (if we implement them)
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function column_cb( $item = '' ) {
		return sprintf(
			'<input type="checkbox" name="%1$s[]" value="%2$s" />',
			$this->_args['singular'],
			$item->ID
		);
	}

	/**
	 * Output the contents of the `bbp_topic_reply_author` column
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function column_bbp_topic_reply_author( $item = '' ) {
		bbp_reply_author_avatar( $item->ID, 50 );
		bbp_reply_author_display_name( $item->ID );
		echo '<br>';
		bbp_reply_author_email( $item->ID );
		echo '<br>';
		bbp_author_ip( array( 'post_id' => $item->ID ) );
	}

	/**
	 * Output the contents of the `bbp_reply_created` column
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function column_bbp_reply_created( $item = '' ) {
		return sprintf( '%1$s <br /> %2$s',
			esc_attr( get_the_date( '', $item ) ),
			esc_attr( get_the_time( '', $item ) )
		);
	}

	/**
	 * Output the contents of the `bbp_reply_content` column
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function column_bbp_reply_content( $item = '' ) {

		// Define actions array
		$actions = array(
			'view' => '<a href="' . bbp_get_reply_url( $item->ID )  . '">' . esc_html__( 'View', 'bbpress' ) . '</a>'
		);

		// Prepend `edit` link
		if ( current_user_can( 'edit_reply', $item->ID ) ) {
			$actions['edit'] = '<a href="' . get_edit_post_link( $item->ID ) . '">' . esc_html__( 'Edit', 'bbpress' ) . '</a>';
			$actions         = array_reverse( $actions );
		}

		// Filter the reply content
		$reply_content = apply_filters( 'bbp_get_reply_content', $item->post_content, $item->ID );
		$reply_actions = $this->row_actions( $actions );

		// Return content & actions
		return $reply_content . $reply_actions;
	}

	/**
	 * Handle bulk action requests
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function process_bulk_action() {
		switch ( $this->current_action() ) {
			case 'trash' :
				break;
			case 'unapprove' :
				break;
			case 'spam' :
				break;
		}
	}

	/**
	 * Prepare the list-table items for display
	 *
	 * @since 2.6.0 bbPress (r5886)
	 */
	public function prepare_items( $topic_id = 0 ) {

		// Sanitize the topic ID
		$topic_id = bbp_get_topic_id( $topic_id );

		// Set column headers
		$this->_column_headers = array(
			$this->get_columns(),
			array(),
			$this->get_sortable_columns()
		);

		// Handle bulk actions
		$this->process_bulk_action();

		// Query parameters
		$per_page     = 5;
		$current_page = $this->get_pagenum();
		$orderby      = ! empty( $_REQUEST['orderby'] ) ? sanitize_key( $_REQUEST['orderby'] ) : 'date';
		$order        = ! empty( $_REQUEST['order']   ) ? sanitize_key( $_REQUEST['order']   ) : 'asc';
		$statuses     = bbp_get_public_reply_statuses();

		// Maybe add private statuses to query
		if ( current_user_can( 'edit_others_replies' ) ) {

			// Default view=all statuses
			$statuses = array_keys( bbp_get_topic_statuses() );

			// Add support for private status
			if ( current_user_can( 'read_private_replies' ) ) {
				$statuses[] = bbp_get_private_status_id();
			}
		}

		// Query for replies
		$reply_query  = new WP_Query( array(
			'post_type'           => bbp_get_reply_post_type(),
			'post_status'         => $statuses,
			'post_parent'         => $topic_id,
			'posts_per_page'      => $per_page,
			'paged'               => $current_page,
			'orderby'             => $orderby,
			'order'               => ucwords( $order ),
			'hierarchical'        => false,
			'ignore_sticky_posts' => true
		) );

		// Get the total number of replies, for pagination
		$total_items = bbp_get_topic_reply_count( $topic_id );

		// Set list table items to queried posts
		$this->items = $reply_query->posts;

		// Set the pagination arguments
		$this->set_pagination_args( array(
			'total_items' => $total_items,
			'per_page'    => $per_page,
			'total_pages' => ceil( $total_items / $per_page )
		) );
	}

	/**
	 * Message to be displayed when there are no items
	 *
	 * @since 2.6.0 bbPress (r5930)
	 */
	public function no_items() {
		esc_html_e( 'No replies to this topic.', 'bbpress' );
	}

	/**
	 * Display the list table
	 *
	 * This custom method is necessary because the one in `WP_List_Table` comes
	 * with a nonce and check that we do not need.
	 *
	 * @since 2.6.0 bbPress (r5930)
	 */
	public function display() {

		// Top
		$this->display_tablenav( 'top' ); ?>

		<table id="bbp-reply-list" class="wp-list-table <?php echo implode( ' ', $this->get_table_classes() ); ?>">
			<thead>
				<tr>
					<?php $this->print_column_headers(); ?>
				</tr>
			</thead>

			<tbody id="the-list" data-wp-lists='list:<?php echo $this->_args['singular']; ?>'>
				<?php $this->display_rows_or_placeholder(); ?>
			</tbody>

			<tfoot>
				<tr>
					<?php $this->print_column_headers( false ); ?>
				</tr>
			</tfoot>
		</table>

		<?php

		// Bottom
		$this->display_tablenav( 'bottom' );
	}

	/**
	 * Generate the table navigation above or below the table
	 *
	 * This custom method is necessary because the one in `WP_List_Table` comes
	 * with a nonce and check that we do not need.
	 *
	 * @since 2.6.0 bbPress (r5930)
	 *
	 * @param string $which
	 */
	protected function display_tablenav( $which = '' ) {
		?>

		<div class="tablenav <?php echo esc_attr( $which ); ?>">
			<?php
				$this->extra_tablenav( $which );
				$this->pagination( $which );
			?>
			<br class="clear" />
		</div>

		<?php
	}

	/**
	 * Generates content for a single row of the table
	 *
	 * @since 2.6.0
	 * @access public
	 *
	 * @param object $item The current item
	 */
	public function single_row( $item ) {

		// Author
		$classes = 'author-' . ( get_current_user_id() == $item->post_author ? 'self' : 'other' );

		// Locked
		if ( wp_check_post_lock( $item->ID ) ) {
			$classes .= ' wp-locked';
		}

		// Hierarchy
		if ( ! empty( $item->post_parent ) ) {
		    $count    = count( get_post_ancestors( $item->ID ) );
		    $classes .= ' level-'. $count;
		} else {
		    $classes .= ' level-0';
		} ?>

		<tr id="post-<?php echo esc_attr( $item->ID ); ?>" class="<?php echo implode( ' ', get_post_class( $classes, $item->ID ) ); ?>">
			<?php $this->single_row_columns( $item ); ?>
		</tr>

		<?php
	}
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

Methods Methods


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.