*/ class Woo_Feed_Manage_list extends Woo_Feed_List_Table { /** ************************************************************************ * Normally we would be querying data from a database and manipulating that * for use in your list table. For this example, we're going to simplify it * slightly and create a pre-built array. Think of this as the data that might * be returned by $wpdb->query() * * In a real-world scenario, you would make your own custom query inside * this class' prepare_items() method. * * @var array **************************************************************************/ /** ************************************************************************ * REQUIRED. Set up a constructor that references the parent constructor. We * use the parent reference to set some default configs. ***************************************************************************/ function __construct() { // Set parent defaults parent::__construct( array( 'singular' => __( 'feed', 'woo-feed' ), // singular name of the listed records 'plural' => __( 'feeds', 'woo-feed' ), // plural name of the listed records 'ajax' => false, // does this table support ajax? ) ); } /** ************************************************************************ * Recommended. This method is called when the parent class can't find a method * specifically build for a given column. Generally, it's recommended to include * one method for each column you want to render, keeping your package class * neat and organized. For example, if the class needs to process a column * named 'title', it would first see if a method named $this->column_title() * exists - if it does, that method will be used. If it doesn't, this one will * be used. Generally, you should try to use custom column methods as much as * possible. * * Since we have defined a column_title() method later on, this method doesn't * need to concern itself with any column with a name of 'title'. Instead, it * needs to handle everything else. * * For more detailed insight into how columns are handled, take a look at * WP_List_Table::single_row_columns() * * @param array $item A singular item (one full row's worth of data) * @param string $column_name The name/slug of the column to be processed * * @return string Text or HTML to be placed inside the column **************************************************************************/ function column_default( $item, $column_name ) { $getItem = $item['option_name']; $statusId = $item['option_id']; $itemInfo = maybe_unserialize( get_option( $getItem ) ); global $regenerating, $regeneratingName; $optionName = str_replace( 'wf_feed_', '', $getItem ); $spinIcon = ( true === $regenerating && $optionName === $regeneratingName ) ? ' wpf_spin reverse_spin' : ''; $disableBtn = true === $regenerating ? ' disabled' : ''; switch ( $column_name ) { case 'option_name': return $optionName; case 'status': if ( ! isset( $itemInfo['status'] ) || ( isset( $itemInfo['status'] ) && 1 === (int) $itemInfo['status'] ) ) { return '
'; } else { return '
'; } case 'provider': $provider = $itemInfo['feedrules']['provider']; return ucwords( str_replace( '_', ' ', $provider ) ); case 'type': $feedType = $itemInfo['feedrules']['feedType']; return strtoupper( str_replace( '_', ' ', $feedType ) ); case 'url': /** @noinspection SpellCheckingInspection */ return sprintf( '%2$s%3$s', $statusId, $itemInfo[ $column_name ], '' . __( 'Copy To Clipboard', 'woo-feed' ) . '' ); case 'last_updated': return $itemInfo[ $column_name ]; case 'view': $export_url = wp_nonce_url( admin_url( 'admin-post.php?action=wf_export_feed&feed=' . $getItem ), 'wpf-export' ); $download_url = wp_nonce_url( admin_url( 'admin-post.php?action=wf_download_feed&feed=' . $getItem ), 'wpf-download-feed' ); $log_download_url = wp_nonce_url( admin_url( 'admin-post.php?action=wf_download_feed_log&feed=' . $getItem ), 'wpf-log-download' ); /** @noinspection HtmlUnknownTarget */ return sprintf( ' ', $itemInfo['url'], esc_html__( 'View', 'woo-feed' ), $getItem, esc_html__( 'Regenerate', 'woo-feed' ), esc_html__( 'Download', 'woo-feed' ), $disableBtn, $spinIcon, esc_html__( 'Export Feed Config', 'woo-feed' ), esc_url( $export_url ), esc_url( $log_download_url ), esc_html__( 'Download Feed Log', 'woo-feed'), esc_url( $download_url ) ); default: return false; } } /** ************************************************************************ * Recommended. This is a custom column method and is responsible for what * is rendered in any column with a name/slug of 'title'. Every time the class * needs to render a column, it first looks for a method named * column_{$column_title} - if it exists, that method is run. If it doesn't * exist, column_default() is called instead. * * This example also illustrates how to implement rollover actions. Actions * should be an associative array formatted as 'slug'=>'link html' - and you * will need to generate the URLs yourself. You could even ensure the links * * @param array $item A singular item (one full row's worth of data) * * @return string Text to be placed inside the column (movie title only) * *************************************************************************@see WP_List_Table::::single_row_columns() */ function column_option_name( $item ) { global $plugin_page; // Build row actions $edit_nonce = wp_create_nonce( 'wf_edit_feed' ); $delete_nonce = wp_create_nonce( 'wf_delete_feed' ); $duplicate_nonce = wp_create_nonce( 'wf_duplicate_feed' ); // $title = '' . $item['option_name'] . ''; $actions = array( 'edit' => sprintf( '' . __( 'Edit', 'woo-feed' ) . '', esc_attr( $plugin_page ), 'edit-feed', $item['option_name'], $edit_nonce ), 'duplicate' => sprintf( '' . __( 'Duplicate', 'woo-feed' ) . '', esc_attr( $plugin_page ), 'duplicate-feed', $item['option_name'], $duplicate_nonce ), 'delete' => sprintf( '' . __( 'Delete', 'woo-feed' ) . '', esc_attr( $plugin_page ), 'delete-feed', absint( $item['option_id'] ), $delete_nonce ), ); // Return the title contents $name = str_replace( 'wf_feed_', '', $item['option_name'] ); $config = maybe_unserialize( maybe_unserialize( $item['option_value'] ) ); if ( isset( $config['feedrules'], $config['feedrules']['filename'] ) ) { $name = sprintf( '%s', esc_attr( $plugin_page ), 'edit-feed', $item['option_name'], $edit_nonce, $config['feedrules']['filename'] ); } return sprintf( '%1$s (id:%2$s)%3$s', $name, esc_html( $item['option_id'] ), $this->row_actions( $actions ) ); } public static function get_feeds() { global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $result = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_id DESC;", 'wf_feed_%' ), 'ARRAY_A' ); return $result; } /** * Delete a Feed. * * @param int $id Feed ID * * @return false */ public static function delete_feed( $id ) { return woo_feed_delete_feed( $id ); } /** * Returns the count of records in the database. * * @return null|string */ public static function record_count() { global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching return $wpdb->get_var( $wpdb->prepare( "SELECT * FROM $wpdb->options WHERE option_name like %s", 'wf_feed_%' ) ); } /** Text displayed when no data is available */ public function no_items() { esc_html_e( 'No feed available.', 'woo-feed' ); } /** ************************************************************************ * REQUIRED if displaying checkboxes or using bulk actions! The 'cb' column * is given special treatment when columns are processed. It ALWAYS needs to * have it's own method. * * @param array $item A singular item (one full row's worth of data) * * @return string Text to be placed inside the column (movie title only) * *************************************************************************@see WP_List_Table::::single_row_columns() */ function column_cb( $item ) { return sprintf( '', /*$1%s*/ $this->_args['singular'], // Let's simply repurpose the table's singular label ("movie") /*$2%s*/ $item['option_id'] // The value of the checkbox should be the record's id ); } function column_name( $item ) { global $plugin_page; $edit_nonce = wp_create_nonce( 'wf_edit_feed' ); $delete_nonce = wp_create_nonce( 'wf_delete_feed' ); $duplicate_nonce = wp_create_nonce( 'wf_duplicate_feed' ); $title = '' . $item['option_name'] . ''; $actions = array( 'edit' => sprintf( '' . __( 'Edit', 'woo-feed' ) . '', esc_attr( $plugin_page ), 'edit-feed', absint( $item['option_id'] ), $edit_nonce ), 'duplicate' => sprintf( '' . __( 'Duplicate', 'woo-feed' ) . '', esc_attr( $plugin_page ), 'duplicate-feed', $item['option_name'], $duplicate_nonce ), 'delete' => sprintf( '' . __( 'Delete', 'woo-feed' ) . '', esc_attr( $plugin_page ), 'delete-feed', absint( $item['option_id'] ), $delete_nonce ), ); return $title . $this->row_actions( $actions ); } /** ************************************************************************ * REQUIRED! This method dictates the table's columns and titles. This should * return an array where the key is the column slug (and class) and the value * is the column's title text. If you need a checkbox for bulk actions, refer * to the $columns array below. * * The 'cb' column is treated differently than the rest. If including a checkbox * column in your table you must create a column_cb() method. If you don't need * bulk actions or checkboxes, simply leave the 'cb' entry out of your array. * * @return array An associative array containing column information: 'slugs'=>'Visible Titles' * *************************************************************************@see WP_List_Table::::single_row_columns() */ function get_columns() { $columns = array( 'cb' => '', // Render a checkbox instead of text 'status' => __( 'Auto Update', 'woo-feed' ), 'option_name' => __( 'Feed Name', 'woo-feed' ), 'provider' => __( 'Provider', 'woo-feed' ), 'type' => __( 'Type', 'woo-feed' ), 'url' => __( 'Feed URL', 'woo-feed' ), 'last_updated' => __( 'Last Updated', 'woo-feed' ), 'view' => __( 'Action', 'woo-feed' ), ); return $columns; } /** ************************************************************************ * Optional. If you want one or more columns to be sortable (ASC/DESC toggle), * you will need to register it here. This should return an array where the * key is the column that needs to be sortable, and the value is db column to * sort by. Often, the key and value will be the same, but this is not always * the case (as the value is a column name from the database, not the list table). * * This method merely defines which columns should be sortable and makes them * clickable - it does not handle the actual sorting. You still need to detect * the ORDERBY and ORDER querystring variables within prepare_items() and sort * your data accordingly (usually by modifying your query). * * @return array An associative array containing all the columns that should be sortable: 'slugs'=>array('data_values',bool) **************************************************************************/ function get_sortable_columns() { $sortable_columns = array( 'option_name' => array( 'option_name', false ), ); return $sortable_columns; } /** ************************************************************************ * Optional. If you need to include bulk actions in your list table, this is * the place to define them. Bulk actions are an associative array in the format * 'slug'=>'Visible Title' * * If this method returns an empty value, no bulk action will be rendered. If * you specify any bulk actions, the bulk actions box will be rendered with * the table automatically on display(). * * Also note that list tables are not automatically wrapped in
elements, * so you will need to create those manually in order for bulk actions to function. * * @return array An associative array containing all the bulk actions: 'slugs'=>'Visible Titles' **************************************************************************/ function get_bulk_actions() { $actions = array( 'bulk-delete' => __( 'Delete', 'woo-feed' ), ); return $actions; } /** ************************************************************************ * Optional. You can handle your bulk actions anywhere or anyhow you prefer. * For this example package, we will handle it in the class to keep things * clean and organized. * * @see $this->prepare_items() **************************************************************************/ public function process_bulk_action() { // Detect when a bulk action is being triggered... if ( 'delete-feed' === $this->current_action() ) { // In our file that handles the request, verify the nonce. $nonce = isset( $_REQUEST['_wpnonce'] ) && ! empty( $_REQUEST['_wpnonce'] ) ? sanitize_text_field( wp_unslash($_REQUEST['_wpnonce']) ) : ''; if ( ! wp_verify_nonce( $nonce, 'wf_delete_feed' ) ) { update_option( 'wpf_message', esc_html__( 'Failed To Delete Feed. You do not have sufficient permission to delete.', 'woo-feed' ), false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=error' ) ); die(); } else { $feed = apply_filters('CTXFEED_filter_securing_input', "GET", @$_GET['feed'], "text"); if ( $feed && self::delete_feed( absint( $feed ) ) ) { update_option( 'wpf_message', esc_html__( 'Feed Deleted Successfully', 'woo-feed' ), false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=success' ) ); die(); } else { update_option( 'wpf_message', esc_html__( 'Failed To Delete Feed', 'woo-feed' ), false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=error' ) ); die(); } } } if ( 'duplicate-feed' === $this->current_action() ) { $nonce = isset( $_REQUEST['_wpnonce'] ) && ! empty( $_REQUEST['_wpnonce'] ) ? sanitize_text_field( $_REQUEST['_wpnonce'] ) : ''; if ( ! wp_verify_nonce( $nonce, 'wf_duplicate_feed' ) ) { update_option( 'wpf_message', esc_html__( 'Failed To Duplicate Feed. You do not have sufficient permission to duplicate.', 'woo-feed' ), false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=error' ) ); die(); } else { $duplicate = woo_feed_duplicate_feed( isset( $_REQUEST['feed'] ) ? sanitize_text_field( $_REQUEST['feed'] ) : '' ); if ( is_wp_error( $duplicate ) ) { update_option( 'wpf_message', $duplicate->get_error_message(), false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=error' ) ); die(); } else { update_option( 'wpf_message', esc_html__( 'Feed Successfully Duplicated.', 'woo-feed' ), false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=success' ) ); die(); } } } // Detect when a bulk action is being triggered... if ( 'edit-feed' === $this->current_action() ) { // In our file that handles the request, verify the nonce. $nonce = isset( $_REQUEST['_wpnonce'] ) && ! empty( $_REQUEST['_wpnonce'] ) ? sanitize_text_field( wp_unslash($_REQUEST['_wpnonce']) ) : ''; if ( ! wp_verify_nonce( $nonce, 'wf_edit_feed' ) ) { wp_die( esc_html__( 'You do not have sufficient permission to delete!', 'woo-feed' ), 403 ); } } $feed = array_map( function ($input) { return apply_filters('CTXFEED_filter_securing_input', "POST", $input, "text"); }, is_array(@$_POST['feed']) ? $_POST['feed'] : [] ); $action = apply_filters('CTXFEED_filter_securing_input', "POST", @$_POST['action'], "text"); $action2 = apply_filters('CTXFEED_filter_securing_input', "POST", @$_POST['action2'], "text"); // If the delete bulk action is triggered if ( ! empty($feed) && ( 'bulk-delete' === $action || 'bulk-delete' === $action2) ) { if ( 'bulk-delete' === $this->current_action() ) { $nonce = isset( $_REQUEST['_wpnonce'] ) && ! empty( $_REQUEST['_wpnonce'] ) ? sanitize_text_field( wp_unslash($_REQUEST['_wpnonce']) ) : ''; if ( ! wp_verify_nonce( $nonce, 'bulk-' . $this->_args['plural'] ) ) { wp_die( esc_html__( 'You do not have sufficient permission to delete!', 'woo-feed' ), 403 ); } else { $delete_ids = array_map( 'absint', $feed ); $delete_ids = array_filter( $delete_ids ); // loop over the array of record IDs and delete them if ( ! empty( $delete_ids ) ) { $count = count( $delete_ids ); foreach ( $delete_ids as $id ) { self::delete_feed( $id ); } $message = sprintf( esc_html( /* translators: %d: number of item deleted. */ _n( '%d Feed Successfully Deleted.', '%d Feeds Successfully Deleted.', $count, 'woo-feed' ) ), $count ); update_option( 'wpf_message', $message, false ); wp_safe_redirect( admin_url( 'admin.php?page=webappick-manage-feeds&wpf_message=success' ) ); die(); } } } } } /** ************************************************************************ * REQUIRED! This is where you prepare your data for display. This method will * usually be used to query the database, sort and filter the data, and generally * get it ready to be displayed. At a minimum, we should set $this->items and * $this->set_pagination_args(), although the following properties and methods * are frequently interacted with here... * * @global WPDB $wpdb * @uses $this->_column_headers * @uses $this->items * @uses $this->get_columns() * @uses $this->get_sortable_columns() * @uses $this->get_pagenum() * @uses $this->set_pagination_args() **************************************************************************/ function prepare_items() { /** * First, lets decide how many records per page to show */ $per_page = 10; /** * REQUIRED. Now we need to define our column headers. This includes a complete * array of columns to be displayed (slugs & titles), a list of columns * to keep hidden, and a list of columns that are sortable. Each of these * can be defined in another method (as we've done here) before being * used to build the value for our _column_headers property. */ $columns = $this->get_columns(); $hidden = array(); $sortable = $this->get_sortable_columns(); /** * REQUIRED. Finally, we build an array to be used by the class for column * headers. The $this->_column_headers property takes an array which contains * 3 other arrays. One for all columns, one for hidden columns, and one * for sortable columns. */ $this->_column_headers = array( $columns, $hidden, $sortable ); /** * Optional. You can handle your bulk actions however you see fit. In this * case, we'll handle them within our package just to keep things clean. */ $this->process_bulk_action(); /** * Instead of querying a database, we're going to fetch the example data * property we created for use in this plugin. This makes this example * package slightly different than one you might build on your own. In * this example, we'll be using array manipulation to sort and paginate * our data. In a real-world implementation, you will probably want to * use sort and pagination data to build a custom query instead, as you'll * be able to use your precisely-queried data immediately. */ $data = $this->get_feeds(); usort( $data, 'woo_feed_usort_reorder' ); /*********************************************************************** * --------------------------------------------------------------------- * vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv * * In a real-world situation, this is where you would place your query. * * For information on making queries in WordPress, see this Codex entry: * http://codex.wordpress.org/Class_Reference/wpdb * * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * --------------------------------------------------------------------- */ /** * REQUIRED for pagination. Let's figure out what page the user is currently * looking at. We'll need this later, so you should always include it in * your own package classes. */ $current_page = $this->get_pagenum(); /** * REQUIRED for pagination. Let's check how many items are in our data array. * In real-world use, this would be the total number of items in your database, * without filtering. We'll need this later, so you should always include it * in your own package classes. */ $total_items = count( $data ); /** * The WP_List_Table class does not handle pagination for us, so we need * to ensure that the data is trimmed to only the current page. We can use * array_slice() to */ $data = array_slice( $data, ( ( $current_page - 1 ) * $per_page ), $per_page ); /** * REQUIRED. We also have to register our pagination options & calculations. */ $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 'total_pages' => ceil( $total_items / $per_page ), // WE have to calculate the total number of pages ) ); // $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 // ) ); /** * REQUIRED. Now we can add our *sorted* data to the items property, where * it can be used by the rest of the class. */ $this->items = $data; } }