<?php
namespace WPForms\Admin\Forms;
use WP_List_Table;
use WP_Post;
use WP_Screen;
use WPForms\Admin\Forms\Table\Facades\Columns;
use WPForms\Forms\Locator;
use WPForms\Integrations\LiteConnect\LiteConnect;
use WPForms\Integrations\LiteConnect\Integration as LiteConnectIntegration;
// IMPORTANT NOTICE:
// This line is needed to prevent fatal errors in the third-party plugins.
// We know about Jetpack (probably others also) can load WP classes during cron jobs or something similar.
require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
/**
* Generate the table on the plugin overview page.
*
* @since 1.8.6
*/
class ListTable extends WP_List_Table {
/**
* Number of forms to show per page.
*
* @since 1.8.6
*
* @var int
*/
public $per_page;
/**
* Number of forms in different views.
*
* @since 1.8.6
*
* @var array
*/
private $count;
/**
* Current view.
*
* @since 1.8.6
*
* @var string
*/
private $view;
/**
* Primary class constructor.
*
* @since 1.8.6
*/
public function __construct() {
// Utilize the parent constructor to build the main class properties.
parent::__construct(
[
'singular' => 'form',
'plural' => 'forms',
'ajax' => false,
]
);
$this->hooks();
// Determine the current view.
$this->view = wpforms()->obj( 'forms_views' )->get_current_view();
/**
* Filters the default number of forms to show per page.
*
* @since 1.0.0
*
* @param int $forms_per_page Number of forms to show per page.
*/
$this->per_page = (int) apply_filters( 'wpforms_overview_per_page', 20 ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Register hooks.
*
* @since 1.8.6
*/
private function hooks() {
add_filter( 'default_hidden_columns', [ $this, 'default_hidden_columns' ], 10, 2 );
}
/**
* Get the instance of a class and store it in itself.
*
* @since 1.8.6
*/
public static function get_instance() {
static $instance;
if ( ! $instance ) {
$instance = new self();
}
return $instance;
}
/**
* Retrieve the table columns.
*
* @since 1.8.6
*
* @return array $columns Array of all the list table columns.
*/
public function get_columns() {
return Columns::get_list_table_columns();
}
/**
* Render the checkbox column.
*
* @since 1.8.6
*
* @param WP_Post $form Form.
*
* @return string
*/
public function column_cb( $form ) {
return '<input type="checkbox" name="form_id[]" value="' . absint( $form->ID ) . '" />';
}
/**
* Render the columns.
*
* @since 1.8.6
*
* @param WP_Post $form CPT object as a form representation.
* @param string $column_name Column Name.
*
* @return string
*/
public function column_default( $form, $column_name ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity
switch ( $column_name ) {
case 'id':
$value = $form->ID;
break;
case 'shortcode':
$value = '[wpforms id="' . $form->ID . '"]';
if ( wpforms_is_form_template( $form->ID ) ) {
$value = __( 'N/A', 'wpforms-lite' );
}
break;
// This slug is not changed to 'date' for backward compatibility.
case 'created':
if ( gmdate( 'Ymd', strtotime( $form->post_date ) ) === gmdate( 'Ymd', strtotime( $form->post_modified ) ) ) {
$value = wp_kses(
sprintf( /* translators: %1$s - Post created date. */
__( 'Created<br/>%1$s', 'wpforms-lite' ),
esc_html( wpforms_datetime_format( $form->post_date ) )
),
[ 'br' => [] ]
);
} else {
$value = wp_kses(
sprintf( /* translators: %1$s - Post modified date. */
__( 'Last Modified<br/>%1$s', 'wpforms-lite' ),
esc_html( wpforms_datetime_format( $form->post_modified ) )
),
[ 'br' => [] ]
);
}
break;
case 'entries':
$value = sprintf(
'<span class="wpforms-lite-connect-entries-count"><a href="%s" data-title="%s">%s%d</a></span>',
esc_url( admin_url( 'admin.php?page=wpforms-entries' ) ),
esc_attr__( 'Entries are securely backed up in the cloud. Upgrade to restore.', 'wpforms-lite' ),
'<svg viewBox="0 0 16 12"><path d="M10.8 2c1.475 0 2.675 1.175 2.775 2.625C15 5.125 16 6.475 16 8a3.6 3.6 0 0 1-3.6 3.6H4a3.98 3.98 0 0 1-4-4 4.001 4.001 0 0 1 2.475-3.7A4.424 4.424 0 0 1 6.8.4c1.4 0 2.625.675 3.425 1.675C10.4 2.025 10.6 2 10.8 2ZM4 10.4h8.4a2.4 2.4 0 0 0 0-4.8.632.632 0 0 0-.113.013.678.678 0 0 1-.112.012c.125-.25.225-.525.225-.825 0-.875-.725-1.6-1.6-1.6a1.566 1.566 0 0 0-1.05.4 3.192 3.192 0 0 0-2.95-2 3.206 3.206 0 0 0-3.2 3.2v.05A2.757 2.757 0 0 0 1.2 7.6 2.795 2.795 0 0 0 4 10.4Zm6.752-4.624a.64.64 0 1 0-.905-.905L6.857 7.86 5.38 6.352a.64.64 0 1 0-.914.896l1.93 1.97a.64.64 0 0 0 .91.004l3.446-3.446Z"/></svg>',
LiteConnectIntegration::get_form_entries_count( $form->ID )
);
break;
case 'modified':
$value = get_post_modified_time( get_option( 'date_format' ), false, $form );
break;
case 'author':
$value = '';
$author = get_userdata( $form->post_author );
if ( ! $author ) {
break;
}
$value = $author->display_name;
$user_edit_url = get_edit_user_link( $author->ID );
if ( ! empty( $user_edit_url ) ) {
$value = '<a href="' . esc_url( $user_edit_url ) . '">' . esc_html( $value ) . '</a>';
}
break;
case 'php':
$value = '<code style="display:block;font-size:11px;">if( function_exists( \'wpforms_get\' ) ){ wpforms_get( ' . $form->ID . ' ); }</code>';
break;
default:
$value = '';
}
/**
* Filters the Forms Overview list table culumn value.
*
* @since 1.0.0
*
* @param string $value Column value.
* @param WP_Post $form CPT object as a form representation.
* @param string $column_name Column Name.
*/
return apply_filters( 'wpforms_overview_table_column_value', $value, $form, $column_name ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Filter the default list of hidden columns.
*
* @since 1.8.6
*
* @param string[] $hidden Array of IDs of columns hidden by default.
* @param WP_Screen $screen WP_Screen object of the current screen.
*
* @return string[]
*/
public function default_hidden_columns( $hidden, $screen ) {
if ( $screen->id !== 'toplevel_page_wpforms-overview' ) {
return $hidden;
}
if ( Columns::has_selected_columns() ) {
return [];
}
return [
'tags',
'author',
Locator::COLUMN_NAME,
];
}
/**
* Render the form name column with action links.
*
* @since 1.8.6
*
* @param WP_Post $form Form.
*
* @return string
*/
public function column_name( $form ) {
$title = $this->get_column_name_title( $form );
$states = _post_states( $form, false );
$actions = $this->get_column_name_row_actions( $form );
// Build the row action links and return the value.
return $title . $states . $actions;
}
/**
* Render the form tags column.
*
* @since 1.8.6
*
* @param WP_Post $form Form.
*
* @return string
*/
public function column_tags( $form ) {
return wpforms()->obj( 'forms_tags' )->column_tags( $form );
}
/**
* Get the form name HTML for the form name column.
*
* @since 1.8.6
*
* @param WP_Post $form Form object.
*
* @return string
*/
protected function get_column_name_title( $form ) {
$title = ! empty( $form->post_title ) ? $form->post_title : $form->post_name;
$name = sprintf(
'<span><strong>%s</strong></span>',
esc_html( $title )
);
if ( $this->view === 'trash' ) {
return $name;
}
if ( wpforms_current_user_can( 'view_form_single', $form->ID ) ) {
$name = sprintf(
'<a href="%s" title="%s" class="row-title" target="_blank" rel="noopener noreferrer"><strong>%s</strong></a>',
esc_url( wpforms_get_form_preview_url( $form->ID ) ),
esc_attr__( 'View preview', 'wpforms-lite' ),
esc_html( $title )
);
}
if ( wpforms_current_user_can( 'view_entries_form_single', $form->ID ) ) {
$name = sprintf(
'<a href="%s" title="%s"><strong>%s</strong></a>',
esc_url(
add_query_arg(
[
'view' => 'list',
'form_id' => $form->ID,
],
admin_url( 'admin.php?page=wpforms-entries' )
)
),
esc_attr__( 'View entries', 'wpforms-lite' ),
esc_html( $title )
);
}
if ( wpforms_current_user_can( 'edit_form_single', $form->ID ) ) {
$name = sprintf(
'<a href="%s" title="%s"><strong>%s</strong></a>',
esc_url(
add_query_arg(
[
'view' => 'fields',
'form_id' => $form->ID,
],
admin_url( 'admin.php?page=wpforms-builder' )
)
),
esc_attr__( 'Edit This Form', 'wpforms-lite' ),
esc_html( $title )
);
}
return $name;
}
/**
* Get the row actions HTML for the form name column.
*
* @since 1.8.6
*
* @param WP_Post $form Form object.
*
* @return string
*/
protected function get_column_name_row_actions( $form ) {
// phpcs:disable WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
/**
* Filters row action links on the 'All Forms' admin page.
*
* @since 1.0.0
*
* @param array $row_actions An array of action links for a given form.
* @param WP_Post $form Form object.
*/
return $this->row_actions( apply_filters( 'wpforms_overview_row_actions', [], $form ) );
// phpcs:enable WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Define bulk actions available for our table listing.
*
* @since 1.8.6
*
* @return array
*/
public function get_bulk_actions() {
return wpforms()->obj( 'forms_bulk_actions' )->get_dropdown_items();
}
/**
* Generate the table navigation above or below the table.
*
* @since 1.8.6
*
* @param string $which The location of the table navigation: 'top' or 'bottom'.
*/
protected function display_tablenav( $which ) {
// If there are some forms just call the parent method.
if ( $this->has_items() ) {
parent::display_tablenav( $which );
return;
}
// Otherwise, display bulk actions menu and "0 items" on the right (pagination).
?>
<div class="tablenav <?php echo esc_attr( $which ); ?>">
<div class="alignleft actions bulkactions">
<?php $this->bulk_actions( $which ); ?>
</div>
<?php
$this->extra_tablenav( $which );
if ( $which === 'top' ) {
$this->pagination( $which );
}
?>
<br class="clear" />
</div>
<?php
}
/**
* Extra controls to be displayed between bulk actions and pagination.
*
* @since 1.8.6
*
* @param string $which The location of the table navigation: 'top' or 'bottom'.
*/
protected function extra_tablenav( $which ) {
wpforms()->obj( 'forms_tags' )->extra_tablenav( $which, $this );
wpforms()->obj( 'forms_views' )->extra_tablenav( $which );
}
/**
* Message to be displayed when there are no forms.
*
* @since 1.8.6
*/
public function no_items() {
wpforms()->obj( 'forms_views' )->get_current_view() === 'templates' ?
esc_html_e( 'No form templates found.', 'wpforms-lite' ) :
esc_html_e( 'No forms found.', 'wpforms-lite' );
}
/**
* Fetch and set up the final data for the table.
*
* @since 1.8.6
*/
public function prepare_items() {
// Set up the columns.
$columns = $this->get_columns();
// Hidden columns (none).
$hidden = get_hidden_columns( $this->screen );
// Define which columns can be sorted - form name, author, date.
$sortable = [
'id' => [ 'ID', false ],
'name' => [ 'title', false ],
'author' => [ 'author', false ],
'created' => [ 'date', false ],
];
// Set column headers.
$this->_column_headers = [ $columns, $hidden, $sortable ];
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$page = $this->get_pagenum();
$order = isset( $_GET['order'] ) && $_GET['order'] === 'asc' ? 'ASC' : 'DESC';
$orderby = isset( $_GET['orderby'] ) ? sanitize_key( $_GET['orderby'] ) : 'ID';
$per_page = $this->get_items_per_page( 'wpforms_forms_per_page', $this->per_page );
// phpcs:enable WordPress.Security.NonceVerification.Recommended
if ( $orderby === 'date' ) {
$orderby = [
'modified' => $order,
'date' => $order,
];
}
$args = [
'orderby' => $orderby,
'order' => $order,
'nopaging' => false,
'posts_per_page' => $per_page,
'paged' => $page,
'no_found_rows' => false,
'post_status' => 'publish',
];
/**
* Filters the `get_posts()` arguments while preparing items for the forms overview table.
*
* @since 1.7.3
*
* @param array $args Arguments array.
*/
$args = (array) apply_filters( 'wpforms_overview_table_prepare_items_args', $args ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
// Giddy up.
$this->items = wpforms()->obj( 'form' )->get( '', $args );
$per_page = $args['posts_per_page'] ?? $this->get_items_per_page( 'wpforms_forms_per_page', $this->per_page );
$this->update_count( $args );
$count_current_view = empty( $this->count[ $this->view ] ) ? 0 : $this->count[ $this->view ];
// Finalize pagination.
$this->set_pagination_args(
[
'total_items' => $count_current_view,
'per_page' => $per_page,
'total_pages' => (int) ceil( $count_current_view / $per_page ),
]
);
$items = is_array( $this->items ) ? $this->items : [];
$form_ids = array_map(
static function ( $form ) {
return (int) $form->ID;
},
$items
);
/**
* Fires after the Forms Overview list table has prepared its items.
*
* Provides the IDs of all forms shown on the current page, allowing
* subscribers to bulk-fetch related per-form data in a single query
* (avoiding per-row N+1 queries during column rendering).
*
* @since 2.0.0
*
* @param int[] $form_ids IDs of forms on the current page.
*/
do_action( 'wpforms_admin_forms_list_table_prepare_items_after', $form_ids );
}
/**
* Calculate and update form counts.
*
* @since 1.8.6
*
* @param array $args Get forms arguments.
*/
private function update_count( $args ) {
/**
* Allow counting forms filtered by a given search criteria.
*
* If result will not contain `all` key, count All Forms without filtering will be performed.
*
* @since 1.7.2
*
* @param array $count Contains counts of forms in different views.
* @param array $args Arguments of the `get_posts`.
*/
$this->count = (array) apply_filters( 'wpforms_overview_table_update_count', [], $args ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
// We do not need to perform all forms count if we have the result already.
if ( isset( $this->count['all'] ) ) {
return;
}
// Count all forms.
$this->count['all'] = wpforms_current_user_can( 'wpforms_view_others_forms' )
? (int) wp_count_posts( 'wpforms' )->publish
: (int) count_user_posts( get_current_user_id(), 'wpforms', true );
/**
* Filters forms count data after counting all forms.
*
* This filter executes only if the result of `wpforms_overview_table_update_count` filter
* doesn't contain `all` key.
*
* @since 1.7.3
*
* @param array $count Contains counts of forms in different views.
* @param array $args Arguments of the `get_posts`.
*/
$this->count = (array) apply_filters( 'wpforms_overview_table_update_count_all', $this->count, $args ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Display the pagination.
*
* @since 1.8.6
*
* @param string $which The location of the table pagination: 'top' or 'bottom'.
*/
protected function pagination( $which ) {
if ( $this->has_items() ) {
parent::pagination( $which );
return;
}
printf(
'<div class="tablenav-pages one-page">
<span class="displaying-num">%s</span>
</div>',
esc_html__( '0 items', 'wpforms-lite' )
);
}
/**
* Extending the `display_rows()` method in order to add hooks.
*
* @since 1.8.6
*/
public function display_rows() {
/**
* Fires before displaying the table rows.
*
* @since 1.5.6.2
*
* @param ListTable $list_table_obj ListTable instance.
*/
do_action( 'wpforms_admin_overview_before_rows', $this ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
parent::display_rows();
/**
* Fires after displaying the table rows.
*
* @since 1.5.6.2
*
* @param ListTable $list_table_obj ListTable instance.
*/
do_action( 'wpforms_admin_overview_after_rows', $this ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Forms search markup.
*
* @since 1.8.6
*
* @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 ) {
wpforms()->obj( 'forms_search' )->search_box( $text, $input_id );
}
/**
* Get the list of views available on forms overview table.
*
* @since 1.8.6
*/
protected function get_views() {
return wpforms()->obj( 'forms_views' )->get_views();
}
}