1<?php
2/**
3 * Helper functions for displaying a list of items in an ajaxified HTML table.
4 *
5 * @package WordPress
6 * @subpackage List_Table
7 * @since 3.1.0
8 */
9
10/**
11 * Fetches an instance of a WP_List_Table class.
12 *
13 * @since 3.1.0
14 *
15 * @global string $hook_suffix
16 *
17 * @param string $class_name The type of the list table, which is the class name.
18 * @param array $args Optional. Arguments to pass to the class. Accepts 'screen'.
19 * @return WP_List_Table|false List table object on success, false if the class does not exist.
20 */
21function _get_list_table( $class_name, $args = array() ) {
22 $core_classes = array(
23 // Site Admin.
24 'WP_Posts_List_Table' => 'posts',
25 'WP_Media_List_Table' => 'media',
26 'WP_Terms_List_Table' => 'terms',
27 'WP_Users_List_Table' => 'users',
28 'WP_Comments_List_Table' => 'comments',
29 'WP_Post_Comments_List_Table' => array( 'comments', 'post-comments' ),
30 'WP_Links_List_Table' => 'links',
31 'WP_Plugin_Install_List_Table' => 'plugin-install',
32 'WP_Themes_List_Table' => 'themes',
33 'WP_Theme_Install_List_Table' => array( 'themes', 'theme-install' ),
34 'WP_Plugins_List_Table' => 'plugins',
35 'WP_Application_Passwords_List_Table' => 'application-passwords',
36
37 // Network Admin.
38 'WP_MS_Sites_List_Table' => 'ms-sites',
39 'WP_MS_Users_List_Table' => 'ms-users',
40 'WP_MS_Themes_List_Table' => 'ms-themes',
41
42 // Privacy requests tables.
43 'WP_Privacy_Data_Export_Requests_List_Table' => 'privacy-data-export-requests',
44 'WP_Privacy_Data_Removal_Requests_List_Table' => 'privacy-data-removal-requests',
45 );
46
47 if ( isset( $core_classes[ $class_name ] ) ) {
48 foreach ( (array) $core_classes[ $class_name ] as $required ) {
49 require_once ABSPATH . 'wp-admin/includes/class-wp-' . $required . '-list-table.php';
50 }
51
52 if ( isset( $args['screen'] ) ) {
53 $args['screen'] = convert_to_screen( $args['screen'] );
54 } elseif ( isset( $GLOBALS['hook_suffix'] ) ) {
55 $args['screen'] = get_current_screen();
56 } else {
57 $args['screen'] = null;
58 }
59
60 /**
61 * Filters the list table class to instantiate.
62 *
63 * @since 6.1.0
64 *
65 * @param string $class_name The list table class to use.
66 * @param array $args An array containing _get_list_table() arguments.
67 */
68 $custom_class_name = apply_filters( 'wp_list_table_class_name', $class_name, $args );
69
70 if ( is_string( $custom_class_name ) && class_exists( $custom_class_name ) ) {
71 $class_name = $custom_class_name;
72 }
73
74 return new $class_name( $args );
75 }
76
77 return false;
78}
79
80/**
81 * Register column headers for a particular screen.
82 *
83 * @see get_column_headers(), print_column_headers(), get_hidden_columns()
84 *
85 * @since 2.7.0
86 *
87 * @param string $screen The handle for the screen to register column headers for. This is
88 * usually the hook name returned by the `add_*_page()` functions.
89 * @param string[] $columns An array of columns with column IDs as the keys and translated
90 * column names as the values.
91 */
92function register_column_headers( $screen, $columns ) {
93 new _WP_List_Table_Compat( $screen, $columns );
94}
95
96/**
97 * Prints column headers for a particular screen.
98 *
99 * @since 2.7.0
100 *
101 * @param string|WP_Screen $screen The screen hook name or screen object.
102 * @param bool $with_id Whether to set the ID attribute or not.
103 */
104function print_column_headers( $screen, $with_id = true ) {
105 $wp_list_table = new _WP_List_Table_Compat( $screen );
106
107 $wp_list_table->print_column_headers( $with_id );
108}
109