* Challenge and guide a user to set up a first form once WPForms is installed.
* @since 1.6.2 Challenge v2
* Number of minutes to complete the Challenge.
if ( current_user_can( wpforms_get_capability_manage_options() ) ) {
public function hooks() {
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_scripts' ] );
add_action( 'wpforms_builder_init', [ $this, 'init_challenge' ] );
add_action( 'admin_footer', [ $this, 'challenge_html' ] );
add_action( 'wpforms_welcome_intro_after', [ $this, 'welcome_html' ] );
add_action( 'wp_ajax_wpforms_challenge_save_option', [ $this, 'save_challenge_option_ajax' ] );
add_action( 'wp_ajax_wpforms_challenge_send_contact_form', [ $this, 'send_contact_form_ajax' ] );
* Check if the current page is related to Challenge.
public function is_challenge_page() {
return wpforms_is_admin_page() ||
$this->is_builder_page() ||
$this->is_form_embed_page();
* Check if the current page is a forms builder page related to Challenge.
public function is_builder_page() {
if ( ! wpforms_is_admin_page( 'builder' ) ) {
if ( ! $this->challenge_active() && ! $this->challenge_inited() ) {
$step = (int) $this->get_challenge_option( 'step' );
$form_id = (int) $this->get_challenge_option( 'form_id' );
if ( $form_id && $step < 2 ) {
$current_form_id = isset( $_GET['form_id'] ) ? (int) $_GET['form_id'] : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$is_new_form = isset( $_GET['newform'] ) ? (int) $_GET['newform'] : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( $is_new_form && $step !== 2 ) {
if ( ! $is_new_form && $form_id !== $current_form_id && $step >= 2 ) {
// In case if user skipped the Challenge by closing the browser window or exiting the builder,
// we need to set the previous Challenge as `canceled`.
// Otherwise, the Form Embed Wizard will think that the Challenge is active.
$this->set_challenge_option(
'finished_date_gmt' => current_time( 'mysql', true ),
* Check if the current page is a form embed page edit related to Challenge.
public function is_form_embed_page() {
if ( ! function_exists( 'get_current_screen' ) || ! is_admin() || ! is_user_logged_in() ) {
$screen = get_current_screen();
if ( ! isset( $screen->id ) || $screen->id !== 'page' || ! $this->challenge_active() ) {
$step = $this->get_challenge_option( 'step' );
if ( ! in_array( $step, [ 3, 4, 5 ], true ) ) {
$embed_page = $this->get_challenge_option( 'embed_page' );
if ( isset( $screen->action ) && $screen->action === 'add' && $embed_page === 0 ) {
if ( isset( $_GET['post'] ) && $embed_page === (int) $_GET['post'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( $is_embed_page && $step < 4 ) {
$this->set_challenge_option( [ 'step' => 4 ] );
* Load scripts and styles.
public function enqueue_scripts() {
if ( ! $this->challenge_can_start() && ! $this->challenge_active() ) {
$min = wpforms_get_min_suffix();
if ( $this->is_challenge_page() ) {
WPFORMS_PLUGIN_URL . "assets/css/challenge{$min}.css",
'wpforms-challenge-admin',
WPFORMS_PLUGIN_URL . "assets/js/admin/challenge/challenge-admin{$min}.js",
'wpforms-challenge-admin',
'wpforms_challenge_admin',
'nonce' => wp_create_nonce( 'wpforms_challenge_ajax_nonce' ),
'minutes_left' => absint( $this->minutes ),
'option' => $this->get_challenge_option(),
'frozen_tooltip' => esc_html__( 'Challenge is frozen.', 'wpforms-lite' ),
if ( $this->is_builder_page() || $this->is_form_embed_page() ) {
WPFORMS_PLUGIN_URL . 'assets/lib/jquery.tooltipster/jquery.tooltipster.min.css',
WPFORMS_PLUGIN_URL . 'assets/lib/jquery.tooltipster/jquery.tooltipster.min.js',
'wpforms-challenge-core',
WPFORMS_PLUGIN_URL . "assets/js/admin/challenge/challenge-core{$min}.js",
[ 'jquery', 'tooltipster', 'wpforms-challenge-admin', 'wpforms-generic-utils' ],
if ( $this->is_builder_page() ) {
'wpforms-challenge-builder',
WPFORMS_PLUGIN_URL . "assets/js/admin/challenge/challenge-builder{$min}.js",
[ 'jquery', 'tooltipster', 'wpforms-challenge-core', 'wpforms-builder' ],
if ( $this->is_form_embed_page() ) {
WPFORMS_PLUGIN_URL . 'assets/lib/font-awesome/css/all.min.css',
// FontAwesome v4 compatibility shims.
'wpforms-font-awesome-v4-shim',
WPFORMS_PLUGIN_URL . 'assets/lib/font-awesome/css/v4-shims.min.css',
'wpforms-challenge-embed',
WPFORMS_PLUGIN_URL . "assets/js/admin/challenge/challenge-embed{$min}.js",
[ 'jquery', 'tooltipster', 'wpforms-challenge-core' ],
* Get 'wpforms_challenge' option schema.
public function get_challenge_option_schema() {
'user_id' => get_current_user_id(),
'embed_page_title' => '',
'started_date_gmt' => '',
'finished_date_gmt' => '',
'feedback_sent' => false,
'feedback_contact_me' => false,
* Get Challenge parameter(s) from Challenge option.
* @param array|string|null $query Query using 'wpforms_challenge' schema keys.
public function get_challenge_option( $query = null ) {
return get_option( 'wpforms_challenge' );
if ( ! is_array( $query ) ) {
$query = array_flip( $query );
$option = get_option( 'wpforms_challenge' );
if ( ! $option || ! is_array( $option ) ) {
return array_intersect_key( $this->get_challenge_option_schema(), $query );
$result = array_intersect_key( $option, $query );
$result = reset( $result );
* Set Challenge parameter(s) to Challenge option.
* @param array $query Query using 'wpforms_challenge' schema keys.
public function set_challenge_option( $query ) {
if ( empty( $query ) || ! is_array( $query ) ) {
$schema = $this->get_challenge_option_schema();
$replace = array_intersect_key( $query, $schema );
// Validate and sanitize the data.
foreach ( $replace as $key => $value ) {
if ( in_array( $key, [ 'step', 'user_id', 'form_id', 'embed_page', 'seconds_spent', 'seconds_left' ], true ) ) {
$replace[ $key ] = absint( $value );
if ( in_array( $key, [ 'feedback_sent', 'feedback_contact_me' ], true ) ) {
$replace[ $key ] = wp_validate_boolean( $value );
$replace[ $key ] = sanitize_text_field( $value );
$option = get_option( 'wpforms_challenge' );
$option = ! $option || ! is_array( $option ) ? $schema : $option;
update_option( 'wpforms_challenge', array_merge( $option, $replace ) );
* Check if any forms are present on a site.
public function website_has_forms() {
// phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters
return (bool) wpforms()->obj( 'form' )->get(
'update_post_meta_cache' => false,
'update_post_term_cache' => false,
'suppress_filters' => true, // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters
* Check if Challenge was started.
public function challenge_started() {
return $this->get_challenge_option( 'status' ) === 'started';
* Check if Challenge was initialized.
public function challenge_inited() {
return $this->get_challenge_option( 'status' ) === 'inited';
* Check if Challenge was paused.
public function challenge_paused() {
return $this->get_challenge_option( 'status' ) === 'paused';
* Check if Challenge was finished.
public function challenge_finished() {
$status = $this->get_challenge_option( 'status' );
return in_array( $status, [ 'completed', 'canceled', 'skipped' ], true );
* Check if Challenge is in progress.
public function challenge_active() {
return ( $this->challenge_inited() || $this->challenge_started() || $this->challenge_paused() ) && ! $this->challenge_finished();
* Force Challenge to start.
public function challenge_force_start() {
* Allow force start Challenge for testing purposes.
* @param bool $is_forced True if Challenge should be started. False by default.
return (bool) apply_filters( 'wpforms_admin_challenge_force_start', false );
* Check if Challenge can be started.
public function challenge_can_start() {
static $can_start = null;
if ( $can_start !== null ) {
if ( $this->challenge_force_skip() ) {
// Challenge is only available on WPForms admin pages or Builder page.
if ( ! wpforms_is_admin_page() && ! wpforms_is_admin_page( 'builder' ) ) {
// No need to check something else in this case.
// The challenge should not start if this is the Forms' Overview page.
if ( wpforms_is_admin_page( 'overview' ) ) {