settings();
$this->hooks();
}
/**
* Filterable widget settings.
*
* @since 1.5.0
*/
public function settings() {
$this->settings = array(
// Number of forms to display in the forms list before "Show More" button appears.
'forms_list_number_to_display' => \apply_filters( 'wpforms_dash_widget_forms_list_number_to_display', 5 ),
// Allow results caching to reduce DB load.
'allow_data_caching' => \apply_filters( 'wpforms_dash_widget_allow_data_caching', true ),
// Transient lifetime in seconds. Defaults to the end of a current day.
'transient_lifetime' => \apply_filters( 'wpforms_dash_widget_transient_lifetime', \strtotime( 'tomorrow' ) - \time() ),
// Allow entries count logging for WPForms Lite.
'allow_entries_count_lite' => \apply_filters( 'wpforms_dash_widget_allow_entries_count_lite', true ),
// Determines if the forms with no entries should appear in a forms list. Once switched, the effect applies after cache expiration.
'display_forms_list_empty_entries' => \apply_filters( 'wpforms_dash_widget_display_forms_list_empty_entries', true ),
);
}
/**
* Widget hooks.
*
* @since 1.5.0
*/
public function hooks() {
\add_action( 'admin_enqueue_scripts', array( $this, 'widget_scripts' ) );
\add_action( 'wp_dashboard_setup', array( $this, 'widget_register' ) );
\add_action( 'admin_init', array( $this, 'hide_widget' ) );
if ( ! empty( $this->settings['allow_entries_count_lite'] ) ) {
\add_action( 'wpforms_process_entry_save', array( $this, 'update_entry_count' ), 10, 3 );
}
\add_action( 'wpforms_create_form', __CLASS__ . '::clear_widget_cache' );
\add_action( 'wpforms_save_form', __CLASS__ . '::clear_widget_cache' );
\add_action( 'wpforms_delete_form', __CLASS__ . '::clear_widget_cache' );
}
/**
* Load widget-specific scripts.
*
* @since 1.5.0
*/
public function widget_scripts() {
$screen = \get_current_screen();
if ( ! isset( $screen->id ) || 'dashboard' !== $screen->id ) {
return;
}
$min = \wpforms_get_min_suffix();
\wp_enqueue_style(
'wpforms-dashboard-widget',
\WPFORMS_PLUGIN_URL . "assets/css/dashboard-widget{$min}.css",
array(),
\WPFORMS_VERSION
);
\wp_enqueue_script(
'wpforms-moment',
\WPFORMS_PLUGIN_URL . 'assets/js/moment.min.js',
array(),
'2.22.2',
true
);
\wp_enqueue_script(
'wpforms-chart',
\WPFORMS_PLUGIN_URL . 'assets/js/chart.min.js',
array( 'wpforms-moment' ),
'2.7.2',
true
);
\wp_enqueue_script(
'wpforms-dashboard-widget',
\WPFORMS_PLUGIN_URL . "lite/assets/js/admin/dashboard-widget{$min}.js",
array( 'jquery', 'wpforms-chart' ),
\WPFORMS_VERSION,
true
);
\wp_localize_script(
'wpforms-dashboard-widget',
'wpforms_dashboard_widget',
array(
'show_more_html' => \esc_html__( 'Show More', 'wpforms-lite' ) . '';
if ( empty( $forms ) ) {
$this->widget_content_no_forms_html();
} else {
$this->widget_content_html();
}
$plugins = \get_plugins();
if (
! \array_key_exists( 'google-analytics-for-wordpress/googleanalytics.php', $plugins ) &&
! \array_key_exists( 'google-analytics-premium/googleanalytics-premium.php', $plugins ) &&
! empty( $forms )
) {
$this->recommended_plugin_block_html();
}
echo '
';
}
/**
* Widget content HTML if a user has no forms.
*
* @since 1.5.0
*/
public function widget_content_no_forms_html() {
$create_form_url = \add_query_arg( 'page', 'wpforms-builder', \admin_url( 'admin.php' ) );
$learn_more_url = 'https://wpforms.com/docs/creating-first-form/?utm_source=WordPress&utm_medium=link&utm_campaign=liteplugin&utm_content=dashboardwidget';
?>
forms_list_block(); ?>
get_entries_count_by_form();
if ( empty( $forms ) ) {
$this->forms_list_block_empty_html();
} else {
$this->forms_list_block_html( $forms );
}
}
/**
* Empty forms list block HTML.
*
* @since 1.5.0
*/
public function forms_list_block_empty_html() {
?>
settings['forms_list_number_to_display'];
?>
$show_forms ) : ?>
settings['allow_data_caching'];
if ( $allow_caching ) {
$transient_name = 'wpforms_dash_widget_lite_entries_by_form';
$cache = \get_transient( $transient_name );
// Filter the cache to clear or alter its data.
$cache = \apply_filters( 'wpforms_dash_widget_lite_cached_data', $cache );
}
// is_array() detects cached empty searches.
if ( $allow_caching && \is_array( $cache ) ) {
return $cache;
}
$forms = \wpforms()->form->get( '', array( 'fields' => 'ids' ) );
if ( empty( $forms ) || ! \is_array( $forms ) ) {
return array();
}
$result = array();
foreach ( $forms as $form_id ) {
$count = \absint( \get_post_meta( $form_id, 'wpforms_entries_count', true ) );
if ( empty( $count ) && empty( $this->settings['display_forms_list_empty_entries'] ) ) {
continue;
}
$result[ $form_id ] = array(
'form_id' => $form_id,
'count' => $count,
'title' => \get_the_title( $form_id ),
);
}
if ( ! empty( $result ) ) {
// Sort forms by entries count (desc).
\uasort( $result, function ( $a, $b ) {
return ( $a['count'] > $b['count'] ) ? - 1 : 1;
} );
}
if ( $allow_caching ) {
// Transient lifetime in seconds. Defaults to the end of a current day.
$transient_lifetime = $this->settings['transient_lifetime'];
\set_transient( $transient_name, $result, $transient_lifetime );
}
return $result;
}
/**
* Hide dashboard widget.
* Use dashboard screen options to make it visible again.
*
* @since 1.5.0
*/
public function hide_widget() {
if ( ! \is_admin() || ! \is_user_logged_in() ) {
return;
}
if ( ! isset( $_GET['wpforms-nonce'] ) || ! \wp_verify_nonce( \sanitize_key( \wp_unslash( $_GET['wpforms-nonce'] ) ), 'wpforms_hide_dash_widget' ) ) {
return;
}
if ( ! isset( $_GET['wpforms-widget'] ) || 'hide' !== $_GET['wpforms-widget'] ) {
return;
}
$user_id = \get_current_user_id();
$metaboxhidden = \get_user_meta( $user_id, 'metaboxhidden_dashboard', true );
if ( ! \is_array( $metaboxhidden ) ) {
\update_user_meta( $user_id, 'metaboxhidden_dashboard', array( 'wpforms_reports_widget_lite' ) );
}
if ( \is_array( $metaboxhidden ) && ! \in_array( 'wpforms_reports_widget_lite', $metaboxhidden, true ) ) {
$metaboxhidden[] = 'wpforms_reports_widget_lite';
\update_user_meta( $user_id, 'metaboxhidden_dashboard', $metaboxhidden );
}
$redirect_url = \remove_query_arg( array( 'wpforms-widget', 'wpforms-nonce' ) );
\wp_safe_redirect( $redirect_url );
exit();
}
/**
* Increase entries count once a form is submitted.
*
* @since 1.5.0
*
* @param array $fields Set of form fields.
* @param array $entry Entry contents.
* @param int|string $form_id Form ID.
*/
public function update_entry_count( $fields, $entry, $form_id ) {
$form_id = \absint( $form_id );
if ( empty( $form_id ) ) {
return;
}
$count = \absint( \get_post_meta( $form_id, 'wpforms_entries_count', true ) );
\update_post_meta( $form_id, 'wpforms_entries_count', $count + 1 );
}
/**
* Clear dashboard widget cached data.
*
* @since 1.5.2
*/
public static function clear_widget_cache() {
delete_transient( 'wpforms_dash_widget_lite_entries_by_form' );
}
}
; ?>)