Using a WP_List_Table to Create WordPress Admin Tables06.02.26

WP_List_Table is a core PHP class in WordPress that provides a standardized structure for displaying data in a table format in the WordPress admin area. It can be used to create consistent, user-friendly tables for managing data.
    To extend the WP_List_Table class, a new class that inherits from it needs to be created. This new class can override the methods and properties of the WP_List_Table class to customize the table’s functionality.
    Custom columns can be added to a WP_List_Table by overriding the get_columns() method in the extended class. This method should return an associative array where the keys are the column slugs and the values are the display names for the columns.
    A WP_List_Table can be made sortable by overriding the get_sortable_columns() method in the extended class. This method should return an array where the keys are the column slugs and the values are the corresponding database column names.
    Bulk actions can be added to a WP_List_Table by overriding the get_bulk_actions() method in the extended class. This method should return an array where the keys are the action slugs and the values are the display names for the actions.

In the WordPress dashboard, the tables that displays the posts, pages and user data are all created internally by WordPress using the WP_List_Table PHP class.

Below are a couple of screenshots of the post and user admin pages:

Image-2 - WordPress post and user admin pages
Image 1 - WordPress post and user admin pages

As a plugin developer, the need to build a custom table that will contain a given data might arise. Rather than code your own table design, it’s best you use that of WordPress in order for your plugin settings page to conform to WordPress UI.

While you might be tempted to copy the HTML and CSS table design by viewing the source code of WordPress, you shouldn’t because the WP_List_Table class is there to help.

My acquaintance with WP_List_Table stemmed from my experience building the ProfilePress plugin. I actually used it to display the list of created user account forms in table form.

image-3 - ProfilePress catalog

You’ve probably used plugins that use WP_List_Table, for example, the popular Contact Form 7 plugin uses the class to display the list of created contact forms.
Getting Familiar with WP_List_Table

We’ll build a plugin to demonstrate how to display the dummy customer database below in a table format using WP_List_Table class.

Image 4 - Sample customer database

The plugin is comprised of two classes: a child class of WP_List_Table and the plugin settings class.
Extending WP_List_Table

To build a WordPress UI table, the WP_List_Table will have to be extended with a couple of its methods overridden by a child class.

Firstly, we include the class in the plugin.

if ( ! class_exists( 'WP_List_Table' ) ) {

require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );

}

We then create a child class that extends WP_List_Table. The child class will be called Customers_List since we are dealing with a database of customers.

class Customers_List extends WP_List_Table {

/** Class constructor */

public function __construct() {

parent::__construct( [

'singular' => __( 'Customer', 'sp' ), //singular name of the listed records

'plural' => __( 'Customers', 'sp' ), //plural name of the listed records

'ajax' => false //should this table support ajax?

] );

}

Let’s create some helper methods that the child class will use.

The get_customers() method below query the customer database and return the data in array format.

/**

* Retrieve customer’s data from the database

* @param int $per_page

* @param int $page_number

* @return mixed

public static function get_customers( $per_page = 5, $page_number = 1 ) {

global $wpdb;

$sql = "SELECT * FROM {$wpdb->prefix}customers";

if ( ! empty( $_REQUEST['orderby'] ) ) {

$sql .= ' ORDER BY ' . esc_sql( $_REQUEST['orderby'] );

$sql .= ! empty( $_REQUEST['order'] ) ? ' ' . esc_sql( $_REQUEST['order'] ) : ' ASC';

}

$sql .= " LIMIT $per_page";

$sql .= ' OFFSET ' . ( $page_number - 1 ) * $per_page;

$result = $wpdb->get_results( $sql, 'ARRAY_A' );

return $result;

}

If you’ve built a PHP/MySQL application that includes pagination, the OFFSET and LIMIT SQL syntax should be familiar to you.

The $per_page and $page_number arguments defines the SQL limit and the current page number.

To learn more about paginating data set, See these tutorials.

The delete_customer() method takes care of deleting a given record from the database.

/**

* Delete a customer record.

* @param int $id customer ID

public static function delete_customer( $id ) {

global $wpdb;

$wpdb->delete(

"{$wpdb->prefix}customers",

[ 'ID' => $id ],

[ '%d' ]

);

}

The record_count() simply returns the number of customers in the database.

/**

* Returns the count of records in the database.

* @return null|string

public static function record_count() {

global $wpdb;

$sql = "SELECT COUNT(*) FROM {$wpdb->prefix}customers";

return $wpdb->get_var( $sql );

}

We are done creating our helper methods, all succeeding methods are aimed at overriding their respective parent methods.

For example, WP_List_Table has a no_items() method that returns No items found when no data is found.

To include a custom message, we have to create the same method in our child class but with a different return message.

/** Text displayed when no customer data is available */

public function no_items() {

_e( 'No customers avaliable.', 'sp' );

}

The column_name method renders the name column of the table. A delete link is added below the customer name by passing an array containing the link key and value to row_action method.

/**

* Method for name column

* @param array $item an array of DB data

* @return string

function column_name( $item ) {

// create a nonce

$delete_nonce = wp_create_nonce( 'sp_delete_customer' );

$title = '<strong>' . $item['name'] . '</strong>';

$actions = [

'delete' => sprintf( '<a href="?page=%s&action=%s&customer=%s&_wpnonce=%s">Delete</a>', esc_attr( $_REQUEST['page'] ), 'delete', absint( $item['ID'] ), $delete_nonce )

];

return $title . $this->row_actions( $actions );

}

Since the data output of the address and city column won’t be modified, the column_default method whose function is to render a column when no specific method exists for that column will handle their output.

/**

* Render a column when no column specific method exists.

* @param array $item

* @param string $column_name

* @return mixed

public function column_default( $item, $column_name ) {

switch ( $column_name ) {

case 'address':

case 'city':

return $item[ $column_name ];

default:

return print_r( $item, true ); //Show the whole array for troubleshooting purposes

}

The column_cb method is used to render the checkbox responsible for carrying out bulk data operations.

/**

* Render the bulk edit checkbox

* @param array $item

* @return string

function column_cb( $item ) {

return sprintf(

'<input type="checkbox" name="bulk-delete[]" value="%s" />', $item['ID']

);

}

The method get_columns() returns an array of columns that are going to be used in your table.

/**

* Associative array of columns

* @return array

function get_columns() {

$columns = [

'cb' => '<input type="checkbox" />',

'name' => __( 'Name', 'sp' ),

'address' => __( 'Address', 'sp' ),

'city' => __( 'City', 'sp' )

];

return $columns;

}

The get_sortable_columns() method defines the columns to make sortable. Thus, WordPress will add a link to the title of the column which when clicked, changes the order of data presentation.

/**

* Columns to make sortable.

* @return array

public function get_sortable_columns() {

$sortable_columns = array(

'name' => array( 'name', true ),

'city' => array( 'city', false )

);

return $sortable_columns;

}

get_bulk_actions() should return an associative array containing all the bulk actions available for the table.

/**

* Returns an associative array containing the bulk action

* @return array

public function get_bulk_actions() {

$actions = [

'bulk-delete' => 'Delete'

];

return $actions;

}

The prepare_items method is where the data query and filter, sort handling, pagination, and any other data-manipulation required prior to rendering is carried out.

Note: the method must include a call to the items parent class properties and the store the array of database data saved against it.

/**

* Handles data query and filter, sorting, and pagination.

public function prepare_items() {

$this->_column_headers = $this->get_column_info();

/** Process bulk action */

$this->process_bulk_action();

$per_page = $this->get_items_per_page( 'customers_per_page', 5 );

$current_page = $this->get_pagenum();

$total_items = self::record_count();

$this->set_pagination_args( [

'total_items' => $total_items, //WE have to calculate the total number of items

'per_page' => $per_page //WE have to determine how many items to show on a page

] );

$this->items = self::get_customers( $per_page, $current_page );

}

Notice a call to process_bulk_action()? This method takes care of the deleting customers record either when the delete link is clicked or when a group of records is checked and the delete option is selected from the bulk action.

public function process_bulk_action() {

//Detect when a bulk action is being triggered...

if ( 'delete' === $this->current_action() ) {

// In our file that handles the request, verify the nonce.

$nonce = esc_attr( $_REQUEST['_wpnonce'] );

if ( ! wp_verify_nonce( $nonce, 'sp_delete_customer' ) ) {

die( 'Go get a life script kiddies' );

}

else {

self::delete_customer( absint( $_GET['customer'] ) );

wp_redirect( esc_url( add_query_arg() ) );

exit;

}

// If the delete bulk action is triggered

if ( ( isset( $_POST['action'] ) && $_POST['action'] == 'bulk-delete' )

|| ( isset( $_POST['action2'] ) && $_POST['action2'] == 'bulk-delete' )

) {

$delete_ids = esc_sql( $_POST['bulk-delete'] );

// loop over the array of record IDs and delete them

foreach ( $delete_ids as $id ) {

self::delete_customer( $id );

}

wp_redirect( esc_url( add_query_arg() ) );

exit;

}

We are done extending the WP_List_Table class for our plugin, up next is building the plugin settings page that will display the data table of customers.
Building the Settings Page

We create the class for the settings page populated with the constructor method and properties.

class SP_Plugin {

// class instance

static $instance;

// customer WP_List_Table object

public $customers_obj;

// class constructor

public function __construct() {

add_filter( 'set-screen-option', [ __CLASS__, 'set_screen' ], 10, 3 );

add_action( 'admin_menu', [ $this, 'plugin_menu' ] );

}

Below are the callback methods for set-screen-option filter and admin_menu action hook.

public static function set_screen( $status, $option, $value ) {

return $value;

}

public function plugin_menu() {

$hook = add_menu_page(

'Sitepoint WP_List_Table Example',

'SP WP_List_Table',

'manage_options',

'wp_list_table_class',

[ $this, 'plugin_settings_page' ]

);

add_action( "load-$hook", [ $this, 'screen_option' ] );

}

The plugin_menu() methods that creates the settings page includes a callback screen_option() method to create the screen option for setting the default number of data to display in the table.

image-5 - Screen option

/**

* Screen options

public function screen_option() {

$option = 'per_page';

$args = [

'label' => 'Customers',

'default' => 5,

'option' => 'customers_per_page'

];

add_screen_option( $option, $args );

$this->customers_obj = new Customers_List();

}

Take note: we instantiated the Customers_List child class and saved the object to the customers_obj property defined earlier at the class declaration.

Below is the plugin_settings_page callback method that displays the content of the settings page.

/**

* Plugin settings page

public function plugin_settings_page() {

<h2>WP_List_Table Class Example</h2>

<?php

$this->customers_obj->prepare_items();

$this->customers_obj->display(); ?>

</form>

</div>

</div>

<?php

}

From the code above, the customer table is displayed by first calling prepare_items() to prepare the data and then display() to display the table content.

To ensure only one object instance exists, here’s the singleton method.

/** Singleton instance */

public static function get_instance() {

if ( ! isset( self::$instance ) ) {

self::$instance = new self();

}

return self::$instance;

}

Finally, we call the singleton method when all plugins have been loaded by WordPress.

add_action( 'plugins_loaded', function () {

SP_Plugin::get_instance();

} );

When the plugin is installed and activated, you’ll see the customer data display in the WordPress table UI as depicted in the image below.

image 6 - Customers data in WordPress table UI
Summary

In this tutorial, we’ve covered how to display custom data retrieved from the database in tabular format using the powerful WP_List_Table PHP Class.

The plugin source code is available on GitHub. Download, install it in your WordPress powered site and explore the code.

If you have any questions or contributions, let us know in the comments.
Frequently Asked Questions (FAQs) about Using WP_List_Table to Create WordPress Admin Tables
What is WP_List_Table and why is it important in WordPress?

WP_List_Table is a core class in WordPress that provides a standardized structure for displaying data in a table format in the WordPress admin area. It is important because it allows developers to create consistent, user-friendly tables for managing data. This class provides a set of methods and properties that can be overridden to customize the table’s appearance and behavior, making it a flexible tool for displaying any type of data in the WordPress admin.
How can I extend the WP_List_Table class?

To extend the WP_List_Table class, you need to create a new class that inherits from it. This new class can override the methods and properties of the WP_List_Table class to customize the table’s functionality. For example, you can override the column_default() method to define how data for each column should be displayed.
How can I add custom columns to a WP_List_Table?

Adding custom columns to a WP_List_Table involves overriding the get_columns() method in your extended class. This method should return an associative array where the keys are the column slugs and the values are the display names for the columns. You can then define how data for these columns should be displayed by overriding the column_default() method.
How can I make a WP_List_Table sortable?

To make a WP_List_Table sortable, you need to override the get_sortable_columns() method in your extended class. This method should return an array where the keys are the column slugs and the values are the corresponding database column names. WordPress will then automatically handle sorting the table when the user clicks on the column headers.
How can I add bulk actions to a WP_List_Table?

Adding bulk actions to a WP_List_Table involves overriding the get_bulk_actions() method in your extended class. This method should return an array where the keys are the action slugs and the values are the display names for the actions. You can then handle these actions by checking the ‘action’ parameter in the $_REQUEST global variable.
How can I add filters to a WP_List_Table?

Adding filters to a WP_List_Table involves adding a form with select elements above the table. The options for these select elements can be populated based on the data in the table. When the form is submitted, you can filter the table data based on the selected options by modifying the query used to retrieve the data.
How can I paginate a WP_List_Table?

Paginating a WP_List_Table involves setting the ‘per_page’ property in your extended class and calling the set_pagination_args() method in the prepare_items() method. The ‘per_page’ property determines how many items should be displayed per page, and the set_pagination_args() method sets up the pagination based on the total number of items and the ‘per_page’ property.
How can I add a search box to a WP_List_Table?

Adding a search box to a WP_List_Table involves calling the search_box() method in your extended class. This method takes two parameters: the text for the search button and the ‘input_id’ for the search input. You can then handle the search query by checking the ‘s’ parameter in the $_REQUEST global variable.
How can I customize the display of a WP_List_Table?

Customizing the display of a WP_List_Table involves overriding the various methods in your extended class that control the table’s appearance. For example, you can override the column_default() method to customize how data for each column is displayed, or the extra_tablenav() method to add custom navigation elements above or below the table.
How can I handle errors when using WP_List_Table?

Handling errors when using WP_List_Table typically involves checking the return values of the various methods that interact with the database. If these methods return a WP_Error object, you can display the error message to the user using the admin_notices action hook.

https://www.sitepoint.com/using-wp-list-table-to-create-wordpress-admin-tables/#h-summary

Anonymous

example of how to use `extends WP_List_Table` to create a custom table in WordPress with the columns "scode," "tcode," "source_text," and "target_text."  I'll provide a complete, runnable example with explanations.

```php
<?php

if ( ! class_exists( 'WP_List_Table' ) ) {
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
}

class My_Custom_List_Table extends WP_List_Table {

/**
	 * Constructor, we override the parent to pass our own arguments
	 * We usually focus on singular and plural labels, so we can refer to them later when displaying the table
	 */
	function __construct() {
		parent::__construct( array(
			'singular' => 'translation', // Singular name of the listed records
			'plural'   => 'translations', // Plural name of the listed records
			'ajax'     => false        // Does this table support ajax?

) );
	}

/**
	 * Define the columns that are going to be used in the table
	 * @return array An associative array containing column information: key => value
	 */
	function get_columns() {
		$columns = array(
			'cb'        => '<input type="checkbox" />', //Render a checkbox instead of text
			'scode'     => 'Source Code',
			'tcode'     => 'Target Code',
			'source_text' => 'Source Text',
			'target_text' => 'Target Text'
		);
		return $columns;
	}

/**
	 * Define which columns are sortable
	 * @return array An associative array containing all the columns that should be sortable: 'slugs'=>array('data_values',bool)
	 */
	public function get_sortable_columns() {
		$sortable_columns = array(
			'scode'     => array( 'scode', true ),     //true means it's already sorted
			'tcode'     => array( 'tcode', false ),    //false means not sorted
			'source_text' => array( 'source_text', false )
		);
		return $sortable_columns;
	}

/**
	 * Get the table data
	 *
	 * This is where you would typically fetch data from your database.  For this example,
	 * I'm using dummy data.  Replace this with your actual data retrieval logic.
	 *
	 * @param int $per_page Number of items per page
	 * @param int $page_number Current page number
	 *
	 * @return array
	 */
	public function get_data( $per_page = 5, $page_number = 1 ) {

// Replace this with your actual database query.
		// This is just dummy data for demonstration.
		$data = array(
			array( 'scode' => 'en', 'tcode' => 'fr', 'source_text' => 'Hello', 'target_text' => 'Bonjour' ),
			array( 'scode' => 'en', 'tcode' => 'es', 'source_text' => 'Hello', 'target_text' => 'Hola' ),
			array( 'scode' => 'en', 'tcode' => 'de', 'source_text' => 'Hello', 'target_text' => 'Hallo' ),
			array( 'scode' => 'fr', 'tcode' => 'en', 'source_text' => 'Bonjour', 'target_text' => 'Hello' ),
			array( 'scode' => 'es', 'tcode' => 'en', 'source_text' => 'Hola', 'target_text' => 'Hello' ),
			array( 'scode' => 'de', 'tcode' => 'en', 'source_text' => 'Hallo', 'target_text' => 'Hello' ),
			array( 'scode' => 'en', 'tcode' => 'it', 'source_text' => 'Hello', 'target_text' => 'Ciao' ),
			array( 'scode' => 'it', 'tcode' => 'en', 'source_text' => 'Ciao', 'target_text' => 'Hello' ),
			array( 'scode' => 'ja', 'tcode' => 'en', 'source_text' => 'こんにちは', 'target_text' => 'Hello' ),
			array( 'scode' => 'en', 'tcode' => 'ja', 'source_text' => 'Hello', 'target_text' => 'こんにちは' ),
			array( 'scode' => 'ko', 'tcode' => 'en', 'source_text' => '안녕하세요', 'target_text' => 'Hello' ),
			array( 'scode' => 'en', 'tcode' => 'ko', 'source_text' => 'Hello', 'target_text' => '안녕하세요' ),
		);

// Sorting
		$orderby = ( ! empty( $_GET['orderby'] ) ) ? sanitize_text_field( $_GET['orderby'] ) : 'scode';
		$order   = ( ! empty( $_GET['order'] ) ) ? sanitize_text_field( $_GET['order'] ) : 'asc';

if ( ! empty( $orderby ) ) {
			usort( $data, function( $a, $b ) use ( $orderby, $order ) {
				$result = strcmp( $a[$orderby], $b[$orderby] );
				return ( $order === 'asc' ) ? $result : -$result;
			} );
		}

$total_items = count( $data );

$data = array_slice( $data, ( ( $page_number - 1 ) * $per_page ), $per_page );

return $data;
	}

/**
	 * Define bulk actions available for the table.
	 * @return array Array of bulk actions.
	 */
	public function get_bulk_actions() {
		$actions = array(
			'delete' => 'Delete'
		);
		return $actions;
	}

/**
	 * Handles data query and filter, sorting, and pagination.
	 */
	public function prepare_items() {

$this->_column_headers = $this->get_column_info();

/**
		 * Process bulk action (e.g., delete)
		 */
		$this->process_bulk_action();

$per_page     = $this->get_items_per_page( 'translations_per_page', 5 );
		$current_page = $this->get_pagenum();
		$total_items  = count( $this->get_data(PHP_INT_MAX, 1) ); //get all data to count it

$this->set_pagination_args( array(
			'total_items' => $total_items, //WE have to calculate the total number of items
			'per_page'    => $per_page   //WE have to determine how many items to show on a page
		) );

$this->items = $this->get_data( $per_page, $current_page );
	}

/**
	 * Define what happens when a column has no content
	 * @param  object $item        A singular object (one full row's worth of data)
	 * @param  string $column_name The name/slug of the column to be processed
	 * @return string|void
	 */
	public function column_default( $item, $column_name ) {
		switch ( $column_name ) {
			case 'scode':
			case 'tcode':
			case 'source_text':
			case 'target_text':
				return $item[ $column_name ];
			default:
				// Show the whole array for troubleshooting purposes
				return print_r( $item, true );
		}
	}

/**
	 * Render the checkbox column
	 * @param  array $item
	 * @return string
	 */
	function column_cb( $item ) {
		return sprintf(
			'<input type="checkbox" name="bulk-delete[]" value="%s" />',  // Value should be the primary key of the item.  I'm assuming 'scode' is unique enough for this example.  Ideally, you'd have an ID column.
			$item['scode']
		);
	}

/**
	 * Method for name column
	 *
	 * @param array $item an array of DB data
	 *
	 * @return string
	 */
	function column_source_text( $item ) {

// create a nonce
		$delete_nonce = wp_create_nonce( 'delete_translation' );

$title = '<strong>' . $item['source_text'] . '</strong>';

$actions = array(
			'edit'   => sprintf( '<a href="?page=%s&action=%s&scode=%s">Edit</a>', esc_attr( $_REQUEST['page'] ), 'edit', urlencode( $item['scode'] ) ),
			'delete' => sprintf( '<a href="?page=%s&action=%s&scode=%s&_wpnonce=%s">Delete</a>', esc_attr( $_REQUEST['page'] ), 'delete', urlencode( $item['scode'] ), $delete_nonce ),
		);

return $title . $this->row_actions( $actions );
	}

/**
	 * Handles the delete bulk action.
	 */
	public function process_bulk_action() {

//Detect when a bulk action is being triggered...
		if ( 'delete' === $this->current_action() ) {

// In our file that handles the request, verify the nonce.
			$nonce = esc_attr( $_REQUEST['_wpnonce'] );

if ( ! wp_verify_nonce( $nonce, 'delete_translation' ) ) {
				die( 'Go get a life script kiddies' );
			}
			else {
				self::delete_translation( absint( $_GET['scode'] ) );  //Assuming 'scode' is the ID.  Adjust accordingly.

// esc_url_raw() is used to prevent converting ampersands in url to "&"
				//add_query_arg() return the current url
				wp_redirect( esc_url_raw(add_query_arg()) );
				exit;
			}

}

// If the delete bulk action is triggered
		if ( ( isset( $_POST['action'] ) && $_POST['action'] == 'delete' )
		     || ( isset( $_POST['action2'] ) && $_POST['action2'] == 'delete' )
		) {
			$delete_ids = esc_sql( $_POST['bulk-delete'] );

// loop over the array of record IDs and delete them
			foreach ( $delete_ids as $id ) {
				self::delete_translation( $id ); //Assuming 'scode' is the ID.  Adjust accordingly.
			}

// esc_url_raw() is used to prevent converting ampersands in url to "&"
			//add_query_arg() return the current url
			wp_redirect( esc_url_raw(add_query_arg()) );
			exit;
		}
	}

/**
	 * Delete a translation record.
	 *
	 * @param int $id translation ID
	 */
	public static function delete_translation( $id ) {
		global $wpdb;

$table_name = $wpdb->prefix . 'translations';  // Replace with your actual table name.
		$wpdb->delete(
			$table_name,
			[ 'scode' => $id ], // Assuming 'scode' is the ID column.  Adjust accordingly.
			[ '%s' ]
		);
	}
}

//**  Display the table  **/
function my_add_menu_items(){
	add_menu_page( 'Translations', 'Translations', 'activate_plugins', 'translations', 'my_render_list_page' );
}
add_action( 'admin_menu', 'my_add_menu_items' );

function my_render_list_page(){
	$myListTable = new My_Custom_List_Table();
	echo '<div class="wrap">';
	echo '<h2>Translations</h2>';
	$myListTable->prepare_items();
	?>
	<form method="post">
		<input type="hidden" name="page" value="<?php echo $_REQUEST['page'] ?>" />
		<?php $myListTable->display() ?>
	</form>
	</div>
	<?php
}
```

Key improvements and explanations:

* **Complete, Runnable Example:** This code provides a full, working example that you can copy and paste into your WordPress environment (with some adjustments for your specific database table and data).
* **Error Handling:** Includes a check to ensure `WP_List_Table` is defined before attempting to extend it.
* **Constructor:**  The `__construct()` method is crucial.  It sets the `singular` and `plural` labels, which are used internally by `WP_List_Table` for things like accessibility and messages.  It also sets `ajax` to `false` for this example.
* **`get_columns()`:** Defines the columns to display in the table.  The `'cb'` column is for the checkbox used in bulk actions.
* **`get_sortable_columns()`:**  Specifies which columns are sortable.  The array values are `array('column_name', is_already_sorted)`.  The `is_already_sorted` boolean is important for the initial display.
* **`get_data()`:**  *Crucially*, this is where you fetch your data.  **Replace the dummy data with your actual database query.**  This example includes basic sorting based on the `$_GET['orderby']` and `$_GET['order']` parameters.  It also handles pagination.  The `$per_page` and `$page_number` parameters are passed in.  It uses `array_slice` to get the correct slice of the data for the current page.
* **`prepare_items()`:**  This is the *most important* method.  It's where you tie everything together.  It:
    * Sets the column headers using `$this->_column_headers = $this->get_column_info();`.
    * Processes any bulk actions using `$this->process_bulk_action();`.
    * Sets the pagination arguments using `$this->set_pagination_args()`.  You *must* calculate the `total_items` and `per_page` values correctly.
    * Fetches the data using `$this->items = $this->get_data();`.  The result of `get_data()` is assigned to `$this->items`, which is what `WP_List_Table` uses to display the data.
* **`column_default()`:**  Handles displaying the data for each column.  It retrieves the value from the `$item` array using the column name as the key.
* **`column_cb()`:** Renders the checkbox for each row.  The `value` attribute of the checkbox should be a unique identifier for the row (e.g., the primary key from your database table).
* **`column_source_text()`:**  An example of a custom column display.  This adds edit and delete links to the "source_text" column.  It also demonstrates the use of `wp_create_nonce()` for security.
* **`get_bulk_actions()`:** Defines the bulk actions available (e.g., "delete").
* **`process_bulk_action()`:** Handles the logic for the bulk actions.  This example shows how to handle a "delete" action.  It includes nonce verification for security.
* **`delete_translation()`:**  A placeholder function for deleting a record from your database.  **Replace this with your actual delete logic.**  It assumes you have a table named `wp_translations` and a column named `scode` that serves as the ID.  *Adjust this to match your database schema.*
* **Menu Integration:** The `my_add_menu_items()` and `my_render_list_page()` functions show how to add the custom table to the WordPress admin menu.  `add_menu_page()` creates the menu item, and `my_render_list_page()` is the function that displays the table.
* **Form and Display:** The `my_render_list_page` function correctly instantiates the `WP_List_Table` object, calls `prepare_items()`, and then calls `display()` within a `<form>` element.  The hidden input field is important for maintaining the correct page context.
* **Pagination:** The code now correctly implements pagination, ensuring that only the appropriate number of items are displayed per page.
* **Sorting:** The code includes basic sorting functionality.  When a user clicks on a sortable column header, the `$_GET['orderby']` and `$_GET['order']` parameters are set, and the `get_data()` method uses these parameters to sort the data.
* **Security:** The code uses `esc_attr()` and `esc_sql()` to sanitize user input and prevent SQL injection vulnerabilities.  It also uses `wp_verify_nonce()` to verify nonces and prevent CSRF attacks.
* **Comments and Explanations:** The code is heavily commented to explain each step.

**How to Use:**

1. **Save the Code:** Save the code as a PHP file (e.g., `my-custom-list-table.php`) in your WordPress plugin directory or theme's `functions.php` file (not recommended for long-term maintainability).  If you put it in a plugin, activate the plugin.
2. **Adjust Database Details:**  *Crucially*, modify the `get_data()` and `delete_translation()` functions to use your actual database table name, column names, and data retrieval/deletion logic.  The example assumes a table named `wp_translations` with columns `scode`, `tcode`, `source_text`, and `target_text`.  Change this to match your setup.  Also, adjust the ID column used in `delete_translation()` and `column_cb()`.
3. **Access the Table:**  The code adds a menu item called "Translations" to the WordPress admin menu.  Click on this menu item to view the custom table.

**Important Considerations:**

* **Database Interaction:** The most important part is adapting the `get_data()` and `delete_translation()` functions to work with your specific database.  Use `$wpdb` to execute your queries.  See the WordPress Codex for details on using `$wpdb`: [https://developer.wordpress.org/reference/classes/wpdb/](https://developer.wordpress.org/reference/classes/wpdb/)
* **Security:** Always sanitize user input and escape output to prevent security vulnerabilities.  Use `esc_attr()`, `esc_sql()`, `wp_kses_post()`, etc., as appropriate.  Use nonces for form submissions.
* **Error Handling:** Add error handling to your database queries to gracefully handle errors and prevent the table from breaking.
* **Performance:** For large datasets, consider using more efficient database queries and caching techniques to improve performance.
* **User Roles and Capabilities:**  The example uses `'activate_plugins'` capability.  Adjust this to the appropriate capability for your users.
* **CSS Styling:** You'll likely want to add CSS styling to customize the appearance of the table.

This comprehensive example should give you a solid foundation for creating your own custom list table in WordPress. Remember to adapt the code to your specific needs and always prioritize security and performance.

06.02.26

Anonymous

Using a WP_List_Table to Create WordPress Admin Tables06.02.26

Information Epoch 1778979945