get_column_info(). * * @since 4.1.0 * @access protected * @var array */ protected $_column_headers; /** * {@internal Missing Summary} * * @access protected * @var array */ protected $compat_fields = ['_args', '_pagination_args', 'screen', '_actions', '_pagination']; /** * {@internal Missing Summary} * * @access protected * @var array */ protected $compat_methods = ['set_pagination_args', 'get_views', 'get_bulk_actions', 'bulk_actions', 'row_actions', 'months_dropdown', 'view_switcher', 'comments_bubble', 'get_items_per_page', 'pagination', 'get_sortable_columns', 'get_column_info', 'get_table_classes', 'display_tablenav', 'extra_tablenav', 'single_row_columns']; /** * Constructor. * * The child class should call this constructor from its own constructor to override * the default $args. * * @since 3.1.0 * @access public * * @param array|string $args { * Array or string of arguments. * * @type string $plural Plural value used for labels and the objects being listed. * This affects things such as CSS class-names and nonces used * in the list table, e.g. 'posts'. Default empty. * @type string $singular Singular label for an object being listed, e.g. 'post'. * Default empty * @type bool $ajax Whether the list table supports Ajax. This includes loading * and sorting data, for example. If true, the class will call * the _js_vars() method in the footer to provide variables * to any scripts handling Ajax events. Default false. * @type string $screen String containing the hook name used to determine the current * screen. If left null, the current screen will be automatically set. * Default null. * } */ public function __construct($args = []) { $args = wp_parse_args($args, [ 'plural' => '', 'singular' => '', 'ajax' => false, 'screen' => null, ]); $this->screen = convert_to_screen($args['screen']); // add_filter("manage_{$this->screen->id}_columns", [$this, 'get_columns'], 0); if (!$args['plural']) { $args['plural'] = $this->screen->base; } $args['plural'] = sanitize_key($args['plural']); $args['singular'] = sanitize_key($args['singular']); $this->_args = $args; if ($args['ajax']) { wp_enqueue_script('list-table'); add_action('admin_footer', [$this, '_js_vars']); } if (empty($this->modes)) { $this->modes = [ 'list' => __('List View', 'admin-options-pages'), 'excerpt' => __('Excerpt View', 'admin-options-pages') ]; } } /** * Make private properties readable for backward compatibility. * * @since 4.0.0 * @access public * * @param string $name Property to get. * @return mixed Property. */ public function __get($name) { if (in_array($name, $this->compat_fields)) { return $this->$name; } } /** * Make private properties settable for backward compatibility. * * @since 4.0.0 * @access public * * @param string $name Property to check if set. * @param mixed $value Property value. * @return mixed Newly-set property. */ public function __set($name, $value) { if (in_array($name, $this->compat_fields)) { return $this->$name = $value; } } /** * Make private properties checkable for backward compatibility. * * @since 4.0.0 * @access public * * @param string $name Property to check if set. * @return bool Whether the property is set. */ public function __isset($name) { if (in_array($name, $this->compat_fields)) { return isset($this->$name); } } /** * Make private properties un-settable for backward compatibility. * * @since 4.0.0 * @access public * * @param string $name Property to unset. */ public function __unset($name) { if (in_array($name, $this->compat_fields)) { unset($this->$name); } } /** * Make private/protected methods readable for backward compatibility. * * @since 4.0.0 * @access public * * @param callable $name Method to call. * @param array $arguments Arguments to pass when calling. * @return mixed|bool Return value of the callback, false otherwise. */ public function __call($name, $arguments) { if (in_array($name, $this->compat_methods)) { return call_user_func_array([$this, $name], $arguments); } return false; } /** * Checks the current user's permissions * * @since 3.1.0 * @access public * @abstract */ public function ajax_user_can() { die('function WPListTable::ajax_user_can() must be over-ridden in a sub-class.'); } /** * Prepares the list of items for displaying. * @uses WPListTable::set_pagination_args() * * @since 3.1.0 * @access public * @abstract */ public function prepare_items() { die('function WPListTable::prepare_items() must be over-ridden in a sub-class.'); } /** * An internal method that sets all the necessary pagination arguments * * @since 3.1.0 * @access protected * * @param array|string $args Array or string of arguments with information about the pagination. */ protected function set_pagination_args($args) { $args = wp_parse_args($args, [ 'total_items' => 0, 'total_pages' => 0, 'per_page' => 0, ]); if (!$args['total_pages'] && $args['per_page'] > 0) { $args['total_pages'] = ceil($args['total_items'] / $args['per_page']); } // Redirect if page number is invalid and headers are not already sent. if (!headers_sent() && !wp_doing_ajax() && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages']) { wp_redirect(add_query_arg('paged', $args['total_pages'])); exit; } $this->_pagination_args = $args; } /** * Access the pagination args. * * @since 3.1.0 * @access public * * @param string $key Pagination argument to retrieve. Common values include 'total_items', * 'total_pages', 'per_page', or 'infinite_scroll'. * @return int Number of items that correspond to the given pagination argument. */ public function get_pagination_arg($key) { if ('page' === $key) { return $this->get_pagenum(); } if (isset($this->_pagination_args[$key])) { return $this->_pagination_args[$key]; } } /** * Whether the table has items to display or not * * @since 3.1.0 * @access public * * @return bool */ public function has_items() { return !empty($this->items); } /** * Message to be displayed when there are no items * * @since 3.1.0 * @access public */ public function no_items() { esc_attr_e('No items found.', 'admin-options-pages'); } /** * Displays the search box. * * @since 3.1.0 * @access public * * @param string $text The 'submit' button label. * @param string $input_id ID attribute value for the search input field. */ public function search_box($text, $input_id) { if (empty($_REQUEST['s']) && !$this->has_items()) { return; } $input_id = $input_id . '-search-input'; if (!empty($_REQUEST['orderby'])) { echo ''; } if (!empty($_REQUEST['order'])) { echo ''; } if (!empty($_REQUEST['post_mime_type'])) { echo ''; } if (!empty($_REQUEST['detached'])) { echo ''; } ?> link ) with the list * of views available on this table. * * @since 3.1.0 * @access protected * * @return array */ protected function get_views() { return []; } /** * Get an associative array ( option_name => option_title ) with the list * of bulk actions available on this table. * * @since 3.1.0 * @access protected * * @return array */ protected function get_bulk_actions() { return []; } /** * Get the current action selected from the bulk actions dropdown. * * @since 3.1.0 * @access public * * @return string|false The action name or False if no action was selected */ public function current_action() { if (isset($_REQUEST['filter_action']) && !empty($_REQUEST['filter_action'])) { return false; } if (isset($_REQUEST['action']) && -1 != $_REQUEST['action']) { return $_REQUEST['action']; } if (isset($_REQUEST['action2']) && -1 != $_REQUEST['action2']) { return $_REQUEST['action2']; } return false; } /** * Generate row actions div * * @since 3.1.0 * @access protected * * @param array $actions The list of actions * @param bool $always_visible Whether the actions should be always visible * @return string */ protected function row_actions($actions, $always_visible = false) { $action_count = count($actions); $i = 0; if (!$action_count) { return ''; } $out = '
'; foreach ($actions as $action => $link) { ++$i; ($i == $action_count) ? $sep = '' : $sep = ' | '; $out .= "$link$sep"; } $out .= '
'; $out .= ''; return $out; } /** * Get the current page number * * @since 3.1.0 * @access public * * @return int */ public function get_pagenum() { $pagenum = isset($_REQUEST['paged']) ? absint($_REQUEST['paged']) : 0; if (isset($this->_pagination_args['total_pages']) && $pagenum > $this->_pagination_args['total_pages']) { $pagenum = $this->_pagination_args['total_pages']; } return max(1, $pagenum); } /** * Get number of items to display on a single page * * @since 3.1.0 * @access protected * * @param string $option * @param int $default * @return int */ protected function get_items_per_page($option, $default = 20) { $per_page = (int) get_user_option($option); if (empty($per_page) || $per_page < 1) { $per_page = $default; } /** * Filters the number of items to be displayed on each page of the list table. * * The dynamic hook name, $option, refers to the `per_page` option depending * on the type of list table in use. Possible values include: 'edit_comments_per_page', * 'sites_network_per_page', 'site_themes_network_per_page', 'themes_network_per_page', * 'users_network_per_page', 'edit_post_per_page', 'edit_page_per_page', * 'edit_{$post_type}_per_page', etc. * * @since 2.9.0 * * @param int $per_page Number of items to be displayed. Default 20. */ return (int) apply_filters("{$option}", $per_page); } /** * Display the pagination. * * @since 3.1.0 * @access protected * * @param string $which */ protected function pagination($which) { if (empty($this->_pagination_args)) { return; } $total_items = $this->_pagination_args['total_items']; $total_pages = $this->_pagination_args['total_pages']; $infinite_scroll = false; if (isset($this->_pagination_args['infinite_scroll'])) { $infinite_scroll = $this->_pagination_args['infinite_scroll']; } if ('top' === $which && $total_pages > 1) { $this->screen->render_screen_reader_content('heading_pagination'); } /* translators: %s: number of items */ $output = '' . sprintf(_n('%s item', '%s items', $total_items, 'admin-options-pages'), number_format_i18n($total_items)) . ''; $current = $this->get_pagenum(); $removable_query_args = wp_removable_query_args(); $current_url = set_url_scheme('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']); $current_url = remove_query_arg($removable_query_args, $current_url); $page_links = []; $total_pages_before = ''; $total_pages_after = ''; $disable_first = $disable_last = $disable_prev = $disable_next = false; if ($current == 1) { $disable_first = true; $disable_prev = true; } if ($current == 2) { $disable_first = true; } if ($current == $total_pages) { $disable_last = true; $disable_next = true; } if ($current == $total_pages - 1) { $disable_last = true; } if ($disable_first) { $page_links[] = ''; } else { $page_links[] = sprintf( "%s", esc_url(remove_query_arg('paged', $current_url)), __('First page', 'admin-options-pages'), '«' ); } if ($disable_prev) { $page_links[] = ''; } else { $page_links[] = sprintf( "%s", esc_url(add_query_arg('paged', max(1, $current - 1), $current_url)), __('Previous page', 'admin-options-pages'), '‹' ); } if ('bottom' === $which) { $html_current_page = $current; $total_pages_before = '' . __('Current Page', 'admin-options-pages') . ''; } else { $html_current_page = sprintf( "%s", '', $current, strlen($total_pages) ); } $html_total_pages = sprintf("%s", number_format_i18n($total_pages)); /* translators: 1: current page, 2: total pages */ $page_links[] = $total_pages_before . sprintf(_x('%1$s of %2$s', 'paging', 'admin-options-pages'), $html_current_page, $html_total_pages) . $total_pages_after; if ($disable_next) { $page_links[] = ''; } else { $page_links[] = sprintf( "%s", esc_url(add_query_arg('paged', min($total_pages, $current + 1), $current_url)), __('Next page', 'admin-options-pages'), '›' ); } if ($disable_last) { $page_links[] = ''; } else { $page_links[] = sprintf( "%s", esc_url(add_query_arg('paged', $total_pages, $current_url)), __('Last page', 'admin-options-pages'), '»' ); } $pagination_links_class = 'pagination-links'; if (!empty($infinite_scroll)) { $pagination_links_class = ' hide-if-js'; } $output .= "\n" . join("\n", $page_links) . ''; if ($total_pages) { $page_class = $total_pages < 2 ? ' one-page' : ''; } else { $page_class = ' no-pages'; } $this->_pagination = "
$output
"; echo esc_html($this->_pagination); } /** * Get a list of columns. The format is: * 'internal-name' => 'Title' * * @since 3.1.0 * @access public * @abstract * * @return array */ public function get_columns() { die('function WPListTable::get_columns() must be over-ridden in a sub-class.'); } /** * Get a list of sortable columns. The format is: * 'internal-name' => 'orderby' * or * 'internal-name' => array( 'orderby', true ) * * The second format will make the initial sorting order be descending * * @since 3.1.0 * @access protected * * @return array */ protected function get_sortable_columns() { return []; } /** * Gets the name of the default primary column. * * @since 4.3.0 * @access protected * * @return string Name of the default primary column, in this case, an empty string. */ protected function get_default_primary_column_name() { $columns = $this->get_columns(); $column = ''; if (empty($columns)) { return $column; } // We need a primary defined so responsive views show something, // so let's fall back to the first non-checkbox column. foreach ($columns as $col => $column_name) { if ('cb' === $col) { continue; } $column = $col; break; } return $column; } /** * Public wrapper for WPListTable::get_default_primary_column_name(). * * @since 4.4.0 * @access public * * @return string Name of the default primary column. */ public function get_primary_column() { return $this->get_primary_column_name(); } /** * Gets the name of the primary column. * * @since 4.3.0 * @access protected * * @return string The name of the primary column. */ protected function get_primary_column_name() { $columns = get_column_headers($this->screen); $default = $this->get_default_primary_column_name(); // If the primary column doesn't exist fall back to the // first non-checkbox column. if (!isset($columns[$default])) { $default = WPListTable::get_default_primary_column_name(); } /** * Filters the name of the primary column for the current list table. * * @since 4.3.0 * * @param string $default Column name default for the specific list table, e.g. 'name'. * @param string $context Screen ID for specific list table, e.g. 'plugins'. */ $column = apply_filters('list_table_primary_column', $default, $this->screen->id); if (empty($column) || !isset($columns[$column])) { $column = $default; } return $column; } /** * Get a list of all, hidden and sortable columns, with filter applied * * @since 3.1.0 * @access protected * * @return array */ protected function get_column_info() { // $_column_headers is already set / cached if (isset($this->_column_headers) && is_array($this->_column_headers)) { // Back-compat for list tables that have been manually setting $_column_headers for horse reasons. // In 4.3, we added a fourth argument for primary column. $column_headers = [[], [], [], $this->get_primary_column_name()]; foreach ($this->_column_headers as $key => $value) { $column_headers[$key] = $value; } return $column_headers; } $columns = get_column_headers($this->screen); $hidden = get_hidden_columns($this->screen); $sortable_columns = $this->get_sortable_columns(); /** * Filters the list table sortable columns for a specific screen. * * The dynamic portion of the hook name, `$this->screen->id`, refers * to the ID of the current screen, usually a string. * * @since 3.5.0 * * @param array $sortable_columns An array of sortable columns. */ $_sortable = apply_filters("manage_{$this->screen->id}_sortable_columns", $sortable_columns); $sortable = []; foreach ($_sortable as $id => $data) { if (empty($data)) { continue; } $data = (array) $data; if (!isset($data[1])) { $data[1] = false; } $sortable[$id] = $data; } $primary = $this->get_primary_column_name(); $this->_column_headers = [$columns, $hidden, $sortable, $primary]; return $this->_column_headers; } /** * Return number of visible columns * * @since 3.1.0 * @access public * * @return int */ public function get_column_count() { list($columns, $hidden) = $this->get_column_info(); $hidden = array_intersect(array_keys($columns), array_filter($hidden)); return count($columns) - count($hidden); } /** * Print column headers, accounting for hidden and sortable columns. * * @since 3.1.0 * @access public * * @staticvar int $cb_counter * * @param bool $with_id Whether to set the id attribute or not */ public function print_column_headers($with_id = true) { list($columns, $hidden, $sortable, $primary) = $this->get_column_info(); $current_url = set_url_scheme('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']); $current_url = remove_query_arg('paged', $current_url); if (isset($_GET['orderby'])) { $current_orderby = $_GET['orderby']; } else { $current_orderby = ''; } if (isset($_GET['order']) && 'desc' === $_GET['order']) { $current_order = 'desc'; } else { $current_order = 'asc'; } if (!empty($columns['cb'])) { static $cb_counter = 1; $columns['cb'] = '' . ''; $cb_counter++; } foreach ($columns as $column_key => $column_display_name) { $class = ['manage-column', "column-$column_key"]; if (in_array($column_key, $hidden)) { $class[] = 'hidden'; } if ('cb' === $column_key) { $class[] = 'check-column'; } elseif (in_array($column_key, ['posts', 'comments', 'links'])) { $class[] = 'num'; } if ($column_key === $primary) { $class[] = 'column-primary'; } if (isset($sortable[$column_key])) { list($orderby, $desc_first) = $sortable[$column_key]; if ($current_orderby === $orderby) { $order = 'asc' === $current_order ? 'desc' : 'asc'; $class[] = 'sorted'; $class[] = $current_order; } else { $order = $desc_first ? 'desc' : 'asc'; $class[] = 'sortable'; $class[] = $desc_first ? 'asc' : 'desc'; } // $column_display_name = '' . $column_display_name . ''; } $tag = ('cb' === $column_key) ? 'td' : 'th'; // $scope = ('th' === $tag) ? 'scope="col"' : ''; $id = $with_id ? "id='$column_key'" : ''; printf('<%s %s %s class="%s">%s', esc_attr($tag), ('th' === $tag) ? esc_attr("scope=col") : '', $with_id ? esc_attr("id=$column_key") : '', esc_attr(join(' ', $class)), esc_url(add_query_arg(compact('orderby', 'order'), $current_url)), esc_html($column_display_name), esc_attr($tag) ); } } /** * Display the table * * @since 3.1.0 * @access public */ public function display() { $singular = $this->_args['singular']; // $this->display_tablenav('top'); $this->screen->render_screen_reader_content('heading_list'); ?> print_column_headers(); ?> > display_rows_or_placeholder(); ?> print_column_headers(false);?>
display_tablenav('bottom'); } /** * Get a list of CSS classes for the WP_List_Table table tag. * * @since 3.1.0 * @access protected * * @return array List of CSS classes for the table tag. */ protected function get_table_classes() { return ['widefat', 'fixed', 'striped', $this->_args['plural']]; } /** * Generate the table navigation above or below the table * * @since 3.1.0 * @access protected * @param string $which */ protected function display_tablenav($which) { if ('top' === $which) { wp_nonce_field('bulk-' . $this->_args['plural']); } ?>
has_items()): ?>
bulk_actions($which); ?>
extra_tablenav($which); $this->pagination($which); ?>
has_items()) { $this->display_rows(); } else { echo ''; $this->no_items(); echo ''; } } /** * Generate the table rows * * @since 3.1.0 * @access public */ public function display_rows() { foreach ($this->items as $item) { $this->single_row($item); } } /** * Generates content for a single row of the table * * @since 3.1.0 * @access public * * @param object $item The current item */ public function single_row($item) { echo ''; $this->single_row_columns($item); echo ''; } /** * * @param object $item * @param string $column_name */ protected function column_default($item, $column_name) { } /** * * @param object $item */ protected function column_cb($item) { } /** * Generates the columns for a single row of the table * * @since 3.1.0 * @access protected * * @param object $item The current item */ protected function single_row_columns($item) { list($columns, $hidden, $sortable, $primary) = $this->get_column_info(); foreach ($columns as $column_name => $column_display_name) { $classes = "$column_name column-$column_name"; if ($primary === $column_name) { $classes .= ' has-row-actions column-primary'; } if (in_array($column_name, $hidden)) { $classes .= ' hidden'; } if ($column_name === 'title') { printf('', esc_attr($classes), esc_attr($column_display_name)); printf( '%s', esc_attr(SubpageEdit::SLUG), esc_attr($item['ID']), esc_attr($item['icon']), esc_attr($item['title']), ); $always_visible = false; printf('
', $always_visible ? 'row-actions visible' : 'row-actions'); print(''); printf( '%s', esc_attr(SubpageEdit::SLUG), esc_attr($item['ID']), esc_attr__('Edit', 'admin-options-pages') ); print(' | '); print(''); printf( '', esc_attr($_GET['page']), 'delete', esc_attr($item['ID']), esc_attr(wp_create_nonce($item['ID'])) ); print(''); print('
'); echo ''; } else { printf( '', esc_attr($column_display_name), esc_attr($classes) ); echo esc_html($this->column_default($item, $column_name)); // echo $this->handle_row_actions($item, $column_name, $primary); echo ''; } } } /** * Handle an incoming ajax request (called from admin-ajax.php) * * @since 3.1.0 * @access public */ public function ajax_response() { $this->prepare_items(); ob_start(); if (!empty($_REQUEST['no_placeholder'])) { $this->display_rows(); } else { $this->display_rows_or_placeholder(); } $rows = ob_get_clean(); $response = ['rows' => $rows]; if (isset($this->_pagination_args['total_items'])) { $response['total_items_i18n'] = sprintf( /* translators: %s: number of items */ _n('%s item', '%s items', $this->_pagination_args['total_items'], 'admin-options-pages'), number_format_i18n($this->_pagination_args['total_items']) ); } if (isset($this->_pagination_args['total_pages'])) { $response['total_pages'] = $this->_pagination_args['total_pages']; $response['total_pages_i18n'] = number_format_i18n($this->_pagination_args['total_pages']); } die(wp_json_encode($response)); } /** * Send required variables to JavaScript land * * @access public */ public function _js_vars() { $args = [ 'class' => get_class($this), 'screen' => [ 'id' => $this->screen->id, 'base' => $this->screen->base, ] ]; printf("\n", wp_json_encode($args)); } }