first commit

This commit is contained in:
2023-09-12 21:41:04 +02:00
commit 3361a7f053
13284 changed files with 2116755 additions and 0 deletions

View File

@@ -0,0 +1,412 @@
<?php
/**
* Generate the table on the plugin overview page.
*
* @since 1.0.0
*/
class WPForms_Overview_Table extends WP_List_Table {
/**
* Number of forms to show per page.
*
* @since 1.0.0
*
* @var int
*/
public $per_page;
/**
* Primary class constructor.
*
* @since 1.0.0
*/
public function __construct() {
// Utilize the parent constructor to build the main class properties.
parent::__construct(
array(
'singular' => 'form',
'plural' => 'forms',
'ajax' => false,
)
);
// Default number of forms to show per page.
$this->per_page = (int) apply_filters( 'wpforms_overview_per_page', 20 );
}
/**
* Retrieve the table columns.
*
* @since 1.0.0
*
* @return array $columns Array of all the list table columns.
*/
public function get_columns() {
$columns = array(
'cb' => '<input type="checkbox" />',
'form_name' => esc_html__( 'Name', 'wpforms-lite' ),
'shortcode' => esc_html__( 'Shortcode', 'wpforms-lite' ),
'created' => esc_html__( 'Created', 'wpforms-lite' ),
);
return apply_filters( 'wpforms_overview_table_columns', $columns );
}
/**
* Render the checkbox column.
*
* @since 1.0.0
*
* @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.0.0
*
* @param WP_Post $form Form.
* @param string $column_name Column Name.
*
* @return string
*/
public function column_default( $form, $column_name ) {
switch ( $column_name ) {
case 'id':
$value = $form->ID;
break;
case 'shortcode':
$value = '[wpforms id="' . $form->ID . '"]';
break;
case 'created':
$value = get_the_date( get_option( 'date_format' ), $form );
break;
case 'modified':
$value = get_post_modified_time( get_option( 'date_format' ), false, $form );
break;
case 'author':
$author = get_userdata( $form->post_author );
$value = $author->display_name;
break;
case 'php':
$value = '<code style="display:block;font-size:11px;">if( function_exists( \'wpforms_get\' ) ){ wpforms_get( ' . $form->ID . ' ); }</code>';
break;
default:
$value = '';
}
return apply_filters( 'wpforms_overview_table_column_value', $value, $form, $column_name );
}
/**
* Render the form name column with action links.
*
* @since 1.0.0
*
* @param WP_Post $form Form.
*
* @return string
*/
public function column_form_name( $form ) {
// Build the row action links and return the value.
return $this->get_column_form_name_title( $form ) . $this->get_column_form_name_row_actions( $form );
}
/**
* Get the form name HTML for the form name column.
*
* @since 1.5.8
*
* @param WP_Post $form Form object.
*
* @return string
*/
protected function get_column_form_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 ( 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(
array(
'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(
array(
'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.5.8
*
* @param WP_Post $form Form object.
*
* @return string
*/
protected function get_column_form_name_row_actions( $form ) {
// Build all of the row action links.
$row_actions = array();
// Edit.
if ( wpforms_current_user_can( 'edit_form_single', $form->ID ) ) {
$row_actions['edit'] = sprintf(
'<a href="%s" title="%s">%s</a>',
esc_url(
add_query_arg(
array(
'view' => 'fields',
'form_id' => $form->ID,
),
admin_url( 'admin.php?page=wpforms-builder' )
)
),
esc_attr__( 'Edit This Form', 'wpforms-lite' ),
esc_html__( 'Edit', 'wpforms-lite' )
);
}
// Entries.
if ( wpforms_current_user_can( 'view_entries_form_single', $form->ID ) ) {
$row_actions['entries'] = sprintf(
'<a href="%s" title="%s">%s</a>',
esc_url(
add_query_arg(
array(
'view' => 'list',
'form_id' => $form->ID,
),
admin_url( 'admin.php?page=wpforms-entries' )
)
),
esc_attr__( 'View entries', 'wpforms-lite' ),
esc_html__( 'Entries', 'wpforms-lite' )
);
}
// Preview.
if ( wpforms_current_user_can( 'view_form_single', $form->ID ) ) {
$row_actions['preview_'] = sprintf(
'<a href="%s" title="%s" target="_blank" rel="noopener noreferrer">%s</a>',
esc_url( wpforms_get_form_preview_url( $form->ID ) ),
esc_attr__( 'View preview', 'wpforms-lite' ),
esc_html__( 'Preview', 'wpforms-lite' )
);
}
// Duplicate.
if ( wpforms_current_user_can( 'create_forms' ) && wpforms_current_user_can( 'view_form_single', $form->ID ) ) {
$row_actions['duplicate'] = sprintf(
'<a href="%s" title="%s">%s</a>',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'duplicate',
'form_id' => $form->ID,
),
admin_url( 'admin.php?page=wpforms-overview' )
),
'wpforms_duplicate_form_nonce'
)
),
esc_attr__( 'Duplicate this form', 'wpforms-lite' ),
esc_html__( 'Duplicate', 'wpforms-lite' )
);
}
// Delete.
if ( wpforms_current_user_can( 'delete_form_single', $form->ID ) ) {
$row_actions['delete'] = sprintf(
'<a href="%s" title="%s">%s</a>',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'delete',
'form_id' => $form->ID,
),
admin_url( 'admin.php?page=wpforms-overview' )
),
'wpforms_delete_form_nonce'
)
),
esc_attr__( 'Delete this form', 'wpforms-lite' ),
esc_html__( 'Delete', 'wpforms-lite' )
);
}
return $this->row_actions( apply_filters( 'wpforms_overview_row_actions', $row_actions, $form ) );
}
/**
* Define bulk actions available for our table listing.
*
* @since 1.0.0
*
* @return array
*/
public function get_bulk_actions() {
$actions = array();
if ( wpforms_current_user_can( 'delete_entries' ) ) {
$actions = array(
'delete' => esc_html__( 'Delete', 'wpforms-lite' ),
);
}
return $actions;
}
/**
* Message to be displayed when there are no forms.
*
* @since 1.0.0
*/
public function no_items() {
printf(
wp_kses( /* translators: %s - WPForms Builder page. */
__( 'Whoops, you haven\'t created a form yet. Want to <a href="%s">give it a go</a>?', 'wpforms-lite' ),
array(
'a' => array(
'href' => array(),
),
)
),
esc_url( admin_url( 'admin.php?page=wpforms-builder' ) )
);
}
/**
* Fetch and setup the final data for the table.
*
* @since 1.0.0
*/
public function prepare_items() {
// Setup the columns.
$columns = $this->get_columns();
// Hidden columns (none).
$hidden = array();
// Define which columns can be sorted - form name, date.
$sortable = array(
'form_name' => array( 'title', false ),
'created' => array( 'date', false ),
);
// Set column headers.
$this->_column_headers = array( $columns, $hidden, $sortable );
// Get forms.
if ( wpforms_current_user_can( 'wpforms_view_others_forms' ) ) {
$total = wp_count_posts( 'wpforms' )->publish;
} else {
$total = count_user_posts( get_current_user_id(), 'wpforms', true );
}
$page = $this->get_pagenum();
$order = isset( $_GET['order'] ) ? $_GET['order'] : 'DESC';
$orderby = isset( $_GET['orderby'] ) ? $_GET['orderby'] : 'ID';
$per_page = $this->get_items_per_page( 'wpforms_forms_per_page', $this->per_page );
$args = array(
'orderby' => $orderby,
'order' => $order,
'nopaging' => false,
'posts_per_page' => $per_page,
'paged' => $page,
'no_found_rows' => false,
'post_status' => 'publish',
);
$data = wpforms()->form->get( '', $args );
// Giddy up.
$this->items = $data;
// Finalize pagination.
$this->set_pagination_args(
array(
'total_items' => $total,
'per_page' => $per_page,
'total_pages' => ceil( $total / $per_page ),
)
);
}
/**
* Extending the `display_rows()` method in order to add hooks.
*
* @since 1.5.6
*/
public function display_rows() {
do_action( 'wpforms_admin_overview_before_rows', $this );
parent::display_rows();
do_action( 'wpforms_admin_overview_after_rows', $this );
}
}

View File

@@ -0,0 +1,334 @@
<?php
/**
* Primary overview page inside the admin which lists all forms.
*
* @since 1.0.0
*/
class WPForms_Overview {
/**
* Primary class constructor.
*
* @since 1.0.0
*/
public function __construct() {
// Maybe load overview page.
add_action( 'admin_init', array( $this, 'init' ) );
// Setup screen options. Needs to be here as admin_init hook it too late.
add_action( 'load-toplevel_page_wpforms-overview', array( $this, 'screen_options' ) );
add_filter( 'set-screen-option', array( $this, 'screen_options_set' ), 10, 3 );
add_filter( 'set_screen_option_wpforms_forms_per_page', [ $this, 'screen_options_set' ], 10, 3 );
}
/**
* Determine if the user is viewing the overview page, if so, party on.
*
* @since 1.0.0
*/
public function init() {
// Only load if we are actually on the overview page.
if ( ! wpforms_is_admin_page( 'overview' ) ) {
return;
}
// Bulk actions.
add_action( 'load-toplevel_page_wpforms-overview', array( $this, 'notices' ) );
add_action( 'load-toplevel_page_wpforms-overview', array( $this, 'process_bulk_actions' ) );
add_filter( 'removable_query_args', array( $this, 'removable_query_args' ) );
// The overview page leverages WP_List_Table so we must load it.
if ( ! class_exists( 'WP_List_Table', false ) ) {
require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
}
// Load the class that builds the overview table.
require_once WPFORMS_PLUGIN_DIR . 'includes/admin/overview/class-overview-table.php';
add_action( 'admin_enqueue_scripts', array( $this, 'enqueues' ) );
add_action( 'wpforms_admin_page', array( $this, 'output' ) );
// Provide hook for addons.
do_action( 'wpforms_overview_init' );
}
/**
* Add per-page screen option to the Forms table.
*
* @since 1.0.0
*/
public function screen_options() {
$screen = get_current_screen();
if ( null === $screen || 'toplevel_page_wpforms-overview' !== $screen->id ) {
return;
}
add_screen_option(
'per_page',
array(
'label' => esc_html__( 'Number of forms per page:', 'wpforms-lite' ),
'option' => 'wpforms_forms_per_page',
'default' => apply_filters( 'wpforms_overview_per_page', 20 ),
)
);
}
/**
* Form table per-page screen option value.
*
* @since 1.0.0
*
* @param bool $keep Whether to save or skip saving the screen option value. Default false.
* @param string $option The option name.
* @param int $value The number of rows to use.
*
* @return mixed
*/
public function screen_options_set( $keep, $option, $value ) {
if ( 'wpforms_forms_per_page' === $option ) {
return $value;
}
return $keep;
}
/**
* Enqueue assets for the overview page.
*
* @since 1.0.0
*/
public function enqueues() {
// Hook for addons.
do_action( 'wpforms_overview_enqueue' );
}
/**
* Build the output for the overview page.
*
* @since 1.0.0
*/
public function output() {
?>
<div id="wpforms-overview" class="wrap wpforms-admin-wrap">
<h1 class="page-title">
<?php esc_html_e( 'Forms Overview', 'wpforms-lite' ); ?>
<?php if ( wpforms_current_user_can( 'create_forms' ) ) : ?>
<a href="<?php echo esc_url( admin_url( 'admin.php?page=wpforms-builder&view=setup' ) ); ?>" class="add-new-h2 wpforms-btn-orange">
<?php esc_html_e( 'Add New', 'wpforms-lite' ); ?>
</a>
<?php endif; ?>
</h1>
<?php
$overview_table = new WPForms_Overview_Table();
$overview_table->prepare_items();
?>
<div class="wpforms-admin-content">
<?php
do_action( 'wpforms_admin_overview_before_table' );
if ( empty( $overview_table->items ) ) {
// Output no forms screen.
echo wpforms_render( 'admin/empty-states/no-forms' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
?>
<form id="wpforms-overview-table" method="get" action="<?php echo esc_url( admin_url( 'admin.php?page=wpforms-overview' ) ); ?>">
<input type="hidden" name="post_type" value="wpforms" />
<input type="hidden" name="page" value="wpforms-overview" />
<?php $overview_table->views(); ?>
<?php $overview_table->display(); ?>
</form>
<?php } ?>
</div>
</div>
<?php
}
/**
* Add admin action notices and process bulk actions.
*
* @since 1.5.7
*/
public function notices() {
$deleted = ! empty( $_REQUEST['deleted'] ) ? sanitize_key( $_REQUEST['deleted'] ) : false; // phpcs:ignore WordPress.Security.NonceVerification
$duplicated = ! empty( $_REQUEST['duplicated'] ) ? sanitize_key( $_REQUEST['duplicated'] ) : false; // phpcs:ignore WordPress.Security.NonceVerification
$notice = array();
if ( $deleted && 'error' !== $deleted ) {
$notice = array(
'type' => 'info',
/* translators: %s - Deleted forms count. */
'msg' => sprintf( _n( '%s form was successfully deleted.', '%s forms were successfully deleted.', $deleted, 'wpforms-lite' ), $deleted ),
);
}
if ( $duplicated && 'error' !== $duplicated ) {
$notice = array(
'type' => 'info',
/* translators: %s - Duplicated forms count. */
'msg' => sprintf( _n( '%s form was successfully duplicated.', '%s forms were successfully duplicated.', $duplicated, 'wpforms-lite' ), $duplicated ),
);
}
if ( 'error' === $deleted || 'error' === $duplicated ) {
$notice = array(
'type' => 'error',
'msg' => esc_html__( 'Security check failed. Please try again.', 'wpforms-lite' ),
);
}
if ( ! empty( $notice ) ) {
\WPForms\Admin\Notice::add( $notice['msg'], $notice['type'] );
}
}
/**
* Process the bulk table actions.
*
* @since 1.5.7
*/
public function process_bulk_actions() {
$ids = isset( $_GET['form_id'] ) ? array_map( 'absint', (array) $_GET['form_id'] ) : array(); // phpcs:ignore WordPress.Security.NonceVerification
$action = ! empty( $_REQUEST['action'] ) ? sanitize_key( $_REQUEST['action'] ) : false; // phpcs:ignore WordPress.Security.NonceVerification
if ( $action === '-1' ) {
$action = ! empty( $_REQUEST['action2'] ) ? sanitize_key( $_REQUEST['action2'] ) : false; // phpcs:ignore WordPress.Security.NonceVerification
}
// Checking the sortable column link.
$is_orderby_link = ! empty( $_REQUEST['orderby'] ) && ! empty( $_REQUEST['order'] );
if ( empty( $ids ) || empty( $action ) || $is_orderby_link ) {
return;
}
// Check exact action values.
if ( ! in_array( $action, [ 'delete', 'duplicate' ], true ) ) {
return;
}
if ( empty( $_GET['_wpnonce'] ) ) {
return;
}
// Check the nonce.
if (
! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'bulk-forms' ) &&
! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'wpforms_' . $action . '_form_nonce' )
) {
return;
}
// Check that we have a method for this action.
if ( ! method_exists( $this, 'bulk_action_' . $action . '_forms' ) ) {
return;
}
$processed_forms = count( $this->{'bulk_action_' . $action . '_forms'}( $ids ) );
// Unset get vars and perform redirect to avoid action reuse.
wp_safe_redirect(
add_query_arg(
$action . 'd',
$processed_forms,
remove_query_arg( array( 'action', 'action2', '_wpnonce', 'form_id', 'paged', '_wp_http_referer' ) )
)
);
exit;
}
/**
* Delete forms.
*
* @since 1.5.7
*
* @param array $ids Form ids to delete.
*
* @return array List of deleted forms.
*/
private function bulk_action_delete_forms( $ids ) {
if ( ! is_array( $ids ) ) {
return [];
}
$deleted = [];
foreach ( $ids as $id ) {
$deleted[ $id ] = wpforms()->form->delete( $id );
}
return array_keys( array_filter( $deleted ) );
}
/**
* Duplicate forms.
*
* @since 1.5.7
*
* @param array $ids Form ids to duplicate.
*
* @return array List of duplicated forms.
*/
private function bulk_action_duplicate_forms( $ids ) {
if ( ! is_array( $ids ) ) {
return [];
}
if ( ! wpforms_current_user_can( 'create_forms' ) ) {
return [];
}
$duplicated = [];
foreach ( $ids as $id ) {
if ( wpforms_current_user_can( 'view_form_single', $id ) ) {
$duplicated[ $id ] = wpforms()->form->duplicate( $id );
}
}
return array_keys( array_filter( $duplicated ) );
}
/**
* Remove certain arguments from a query string that WordPress should always hide for users.
*
* @since 1.5.7
*
* @param array $removable_query_args An array of parameters to remove from the URL.
*
* @return array Extended/filtered array of parameters to remove from the URL.
*/
public function removable_query_args( $removable_query_args ) {
if ( wpforms_is_admin_page( 'overview' ) ) {
$removable_query_args[] = 'duplicated';
}
return $removable_query_args;
}
}
new WPForms_Overview();