namespace WPForms\Admin\Pages;
* Abstract class for admin pages.
* Runtime data used for generating page HTML.
protected $output_data = [];
public function __construct() {
if ( ! wpforms_current_user_can() ) {
public function hooks(): void {
$plugin = static::get_plugin_name();
add_action( "wp_ajax_wpforms_page_check_{$plugin}_status", [ $this, 'ajax_check_plugin_status' ] );
add_action( 'wpforms_plugin_activated', [ $this, 'plugin_activated' ] );
// Check what page we are on.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$page = isset( $_GET['page'] ) ? sanitize_key( $_GET['page'] ) : '';
// Only load if we are actually on the correct page.
if ( $page !== static::SLUG ) {
add_filter( 'wpforms_admin_header', '__return_false' );
add_action( 'wpforms_admin_page', [ $this, 'output' ] );
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
do_action( 'wpforms_admin_pages_page_' . static::get_plugin_name() . '_hooks' );
* Enqueue JS and CSS files.
public function enqueue_assets(): void {
$min = wpforms_get_min_suffix();
WPFORMS_PLUGIN_URL . 'assets/lib/lity/lity.min.css',
WPFORMS_PLUGIN_URL . 'assets/lib/lity/lity.min.js',
// Custom styles for Lity image size limitation.
.lity-image .lity-container {
max-width: 1040px !important;
max-width: 1040px !important;
'wpforms-admin-page-' . static::get_plugin_name(),
WPFORMS_PLUGIN_URL . "assets/js/admin/pages/common{$min}.js",
'wpforms-admin-page-' . static::get_plugin_name(),
* Generate and output page HTML.
public function output(): void {
echo '<div id="wpforms-admin-' . esc_attr( static::get_plugin_name() ) . '" class="wrap wpforms-admin-wrap wpforms-admin-plugin-landing">';
$this->output_section_heading();
$this->output_section_screenshot();
$this->output_section_footer();
$this->output_section_step_install();
$this->output_section_step_setup();
$this->output_section_step_result();
* Generate and output step 'Install' section HTML.
* @noinspection HtmlUnknownTarget
protected function output_section_step_install(): void {
$step = $this->get_data_step_install();
$button_format = '<button class="button %3$s" data-plugin="%1$s" data-action="%4$s" data-provider="%5$s">%2$s</button>';
! $this->output_data['plugin_installed'] &&
! $this->output_data['pro_plugin_installed'] &&
! wpforms_can_install( 'plugin' )
$button_format = '<a class="link" href="%1$s" target="_blank" rel="nofollow noopener">%2$s <span aria-hidden="true" class="dashicons dashicons-external"></span></a>';
$plugin_attr = wpforms_is_url( $step['plugin'] ) ? esc_url( $step['plugin'] ) : esc_attr( $step['plugin'] );
$button = sprintf( $button_format, $plugin_attr, esc_html( $step['button_text'] ), esc_attr( $step['button_class'] ), esc_attr( $step['button_action'] ), esc_attr( static::get_plugin_name() ) );
'<section class="step step-install">
<img src="%1$s" alt="%2$s" />
<i class="loader hidden"></i>
esc_url( WPFORMS_PLUGIN_URL . 'assets/images/' . $step['icon'] ),
esc_attr__( 'Step 1', 'wpforms-lite' ),
esc_html( $step['heading'] ),
esc_html( $step['description'] ),
wp_kses( $button, $button_allowed_html )
* Generate and output step 'Setup' section HTML.
* @noinspection HtmlUnknownTarget
protected function output_section_step_setup(): void {
$step = $this->get_data_step_setup();
'<section class="step step-setup %1$s">
<img src="%2$s" alt="%3$s" />
<i class="loader hidden"></i>
<button class="button %6$s" data-url="%7$s">%8$s</button>
esc_attr( $step['section_class'] ),
esc_url( WPFORMS_PLUGIN_URL . 'assets/images/' . $step['icon'] ),
esc_attr__( 'Step 2', 'wpforms-lite' ),
esc_html( $step['heading'] ),
esc_html( $step['description'] ),
esc_attr( $step['button_class'] ),
esc_url( admin_url( $this->config[ static::get_plugin_name() . '_onboarding' ] ) ),
esc_html( $step['button_text'] )
* Generate and output footer section HTML.
protected function output_section_footer(): void {
// Default implementation - can be overridden by child classes.
* @return array Step data.
protected function get_data_step_install(): array {
$step['heading'] = $this->get_install_heading();
$step['description'] = $this->get_install_description();
$this->output_data['all_plugins'] = get_plugins();
$this->output_data['plugin_installed'] = array_key_exists( $this->config['lite_plugin'], $this->output_data['all_plugins'] );
$this->output_data['plugin_activated'] = false;
$this->output_data['pro_plugin_installed'] = array_key_exists( $this->config['pro_plugin'], $this->output_data['all_plugins'] );
$this->output_data['pro_plugin_activated'] = false;
if ( ! $this->output_data['plugin_installed'] && ! $this->output_data['pro_plugin_installed'] ) {
$step['icon'] = 'step-1.svg';
$step['button_text'] = $this->get_install_button_text();
$step['button_class'] = 'button-primary';
$step['button_action'] = 'install';
$step['plugin'] = $this->config['lite_download_url'];
if ( ! wpforms_can_install( 'plugin' ) ) {
$step['heading'] = $this->get_plugin_title();
$step['description'] = '';
$step['button_text'] = $this->get_plugin_title() . ' on WordPress.org';
$step['plugin'] = $this->config['lite_wporg_url'];
$this->output_data['plugin_activated'] =
is_plugin_active( $this->config['lite_plugin'] ) || is_plugin_active( $this->config['pro_plugin'] );
$step['icon'] = $this->output_data['plugin_activated'] ? 'step-complete.svg' : 'step-1.svg';
$this->output_data['plugin_activated']
? $this->get_installed_activated_text()
: $this->get_activate_text();
$step['button_class'] = $this->output_data['plugin_activated']
$step['button_action'] = $this->output_data['plugin_activated'] ? '' : 'activate';
$this->output_data['pro_plugin_installed'] ? $this->config['pro_plugin'] : $this->config['lite_plugin'];
$step['is_pro'] = $this->output_data['pro_plugin_installed'];
* @return array Step data.
protected function get_data_step_setup(): array {
$this->output_data['plugin_setup'] = false;
if ( $this->output_data['plugin_activated'] ) {
$this->output_data['plugin_setup'] = $this->is_plugin_configured();
$step['icon'] = 'step-2.svg';
$step['section_class'] = $this->output_data['plugin_activated'] ? '' : 'grey';
$step['heading'] = $this->get_setup_heading();
$step['description'] = $this->get_setup_description();
$step['button_text'] = $this->get_setup_button_text();
$step['button_class'] = 'grey disabled';
if ( $this->output_data['plugin_setup'] ) {
$step['icon'] = 'step-complete.svg';
$step['section_class'] = '';
$step['button_text'] = $this->get_setup_completed_text();
$step['button_class'] = $this->output_data['plugin_activated'] ? 'button-primary' : 'grey disabled';
* Ajax endpoint. Check plugin setup status.
* Used to properly init the step 2 section after completing step 1.
public function ajax_check_plugin_status(): void {
! check_ajax_referer( 'wpforms-admin', 'nonce', false ) ||
! wpforms_current_user_can()
[ 'error' => esc_html__( 'You do not have permission.', 'wpforms-lite' ) ]
if ( ! $this->is_plugin_available() ) {
[ 'error' => esc_html__( 'Plugin unavailable.', 'wpforms-lite' ) ]
$result['setup_status'] = (int) $this->is_plugin_configured();
$result['license_level'] = 'lite';
$result['step3_button_url'] = $this->config[ static::get_plugin_name() . '_addon_page' ];
if ( $this->is_pro_active() ) {
$result['license_level'] = 'pro';
$result['result_status'] = $this->is_plugin_finished_setup();
$result['addon_installed'] = (int) array_key_exists( $this->config[ static::get_plugin_name() . '_addon' ], get_plugins() );
wp_send_json_success( $result );
* Set the source of the plugin installation.
* @param string $plugin_basename The basename of the plugin.
public function plugin_activated( string $plugin_basename ): void {
if ( $plugin_basename !== $this->config['lite_plugin'] ) {
$source = wpforms()->is_pro() ? 'WPForms' : 'WPForms Lite';
update_option( static::get_plugin_name() . '_source', $source, false );
update_option( static::get_plugin_name() . '_date', time(), false );
* @return array Array of strings.
* @noinspection HtmlUnknownTarget
protected function get_js_strings(): array {
$error_could_not_install = sprintf(
wp_kses( /* translators: %1$s - Lite plugin download URL. */
__( 'Could not install the plugin automatically. Please <a href="%1$s">download</a> it and install it manually.', 'wpforms-lite' ),
esc_url( $this->config['lite_download_url'] ?? '' )
$error_could_not_activate = sprintf(
wp_kses( /* translators: %1$s - Plugins page URL. */
__( 'Could not activate the plugin. Please activate it on the <a href="%1$s">Plugins page</a>.', 'wpforms-lite' ),
esc_url( admin_url( 'plugins.php' ) )
'installing' => esc_html__( 'Installing...', 'wpforms-lite' ),
'activating' => esc_html__( 'Activating...', 'wpforms-lite' ),
'activated' => $this->get_installed_activated_text(),
'activated_pro' => $this->get_pro_installed_activated_text(),
'install_now' => esc_html__( 'Install Now', 'wpforms-lite' ),
'activate_now' => esc_html__( 'Activate Now', 'wpforms-lite' ),
'download_now' => esc_html__( 'Download Now', 'wpforms-lite' ),
'plugins_page' => esc_html__( 'Go to Plugins page', 'wpforms-lite' ),
'error_could_not_install' => $error_could_not_install,
'error_could_not_activate' => $error_could_not_activate,
static::get_plugin_name() . '_manual_install_url' => $this->config['lite_download_url'],
static::get_plugin_name() . '_manual_activate_url' => admin_url( 'plugins.php' ),
* Get the plugin name for use in IDs, CSS classes, and config keys.
* @return string Plugin name.
abstract protected static function get_plugin_name(): string;
* Generate and output heading section HTML.
* @noinspection HtmlUnknownTarget
public function output_section_heading(): void {
$strings = $this->get_heading_strings();
<img class="img-top" src="%1$s" alt="%2$s"/>