<?php
// phpcs:disable Generic.Commenting.DocComment.MissingShort
/** @noinspection PhpUndefinedNamespaceInspection */
/** @noinspection PhpUndefinedClassInspection */
// phpcs:enable Generic.Commenting.DocComment.MissingShort
namespace WPForms\Integrations\Elementor;
use Elementor\Plugin;
use Elementor\Widget_Base;
use Elementor\Controls_Manager;
/**
* WPForms widget for Elementor page builder.
*
* @since 1.6.2
*/
class Widget extends Widget_Base {
/**
* Script dependencies.
*
* @since 1.9.1
*
* @return array
*/
public function get_script_depends(): array {
return [ 'wpforms-elementor' ];
}
/**
* Get widget name.
*
* Retrieve shortcode widget name.
*
* @since 1.6.2
*
* @return string Widget name.
*/
public function get_name() {
return 'wpforms';
}
/**
* Get widget title.
*
* Retrieve shortcode widget title.
*
* @since 1.6.2
*
* @return string Widget title.
*/
public function get_title() {
return __( 'WPForms', 'wpforms-lite' );
}
/**
* Get widget icon.
*
* Retrieve shortcode widget icon.
*
* @since 1.6.2
*
* @return string Widget icon.
*/
public function get_icon() {
return 'icon-wpforms';
}
/**
* Get widget keywords.
*
* Retrieve the list of keywords the widget belongs to.
*
* @since 1.6.2
*
* @return array Widget keywords.
*/
public function get_keywords() {
return [
'form',
'forms',
'wpforms',
'contact form',
'sullie',
'the dude',
];
}
/**
* Get widget categories.
*
* @since 1.6.2
*
* @return array Widget categories.
*/
public function get_categories() {
return [
'basic',
];
}
/**
* Register widget controls.
*
* Adds different input fields to allow the user to change and customize the widget settings.
*
* @since 1.6.2
*/
protected function register_controls() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
$this->content_controls();
}
/**
* Register content tab controls.
*
* @since 1.6.2
*
* @noinspection PhpUndefinedMethodInspection
* @noinspection HtmlUnknownTarget
*/
protected function content_controls() {
$this->start_controls_section(
'section_form',
[
'label' => esc_html__( 'Form', 'wpforms-lite' ),
'tab' => Controls_Manager::TAB_CONTENT,
]
);
$forms = $this->get_forms();
if ( empty( $forms ) ) {
$this->add_empty_forms_notice();
}
$this->add_control(
'form_id',
[
'label' => esc_html__( 'Form', 'wpforms-lite' ),
'type' => Controls_Manager::SELECT,
'label_block' => true,
'options' => $forms,
'default' => '0',
]
);
$this->add_control(
'edit_form',
[
'show_label' => false,
'type' => Controls_Manager::RAW_HTML,
'raw' => wp_kses( /* translators: %s - WPForms documentation link. */
__( 'Need to make changes? <a href="#">Edit the selected form.</a>', 'wpforms-lite' ),
[ 'a' => [] ]
),
'condition' => [
'form_id!' => '0',
],
]
);
$this->add_control(
'test_form_notice',
[
'show_label' => false,
'type' => Controls_Manager::RAW_HTML,
'raw' => sprintf(
wp_kses( /* translators: %s - WPForms documentation link. */
__( '<b>Heads up!</b> Don\'t forget to test your form. <a href="%s" target="_blank" rel="noopener noreferrer">Check out our complete guide!</a>', 'wpforms-lite' ),
[
'b' => [],
'br' => [],
'a' => [
'href' => [],
'rel' => [],
'target' => [],
],
]
),
'https://wpforms.com/docs/how-to-properly-test-your-wordpress-forms-before-launching-checklist/'
),
'condition' => [
'form_id!' => '0',
],
'content_classes' => 'elementor-panel-alert elementor-panel-alert-info',
]
);
// The button opens the Form Builder, so it is only offered to users allowed to create forms.
if ( wpforms_current_user_can( 'create_forms' ) ) {
$this->add_control(
'add_form_btn',
[
'show_label' => false,
'label_block' => false,
'type' => Controls_Manager::BUTTON,
'button_type' => 'default',
'separator' => 'before',
'text' => '<b>+</b>' . esc_html__( 'New form', 'wpforms-lite' ),
'event' => 'elementorWPFormsAddFormBtnClick',
]
);
}
$this->add_legacy_styles_notice();
$this->end_controls_section();
$this->start_controls_section(
'section_display',
[
'label' => esc_html__( 'Display Options', 'wpforms-lite' ),
'tab' => Controls_Manager::TAB_CONTENT,
'condition' => [
'form_id!' => '0',
],
]
);
$this->add_control(
'display_form_name',
[
'label' => esc_html__( 'Form Name', 'wpforms-lite' ),
'type' => Controls_Manager::SWITCHER,
'label_on' => esc_html__( 'Show', 'wpforms-lite' ),
'label_off' => esc_html__( 'Hide', 'wpforms-lite' ),
'return_value' => 'yes',
'condition' => [
'form_id!' => '0',
],
]
);
$this->add_control(
'display_form_description',
[
'label' => esc_html__( 'Form Description', 'wpforms-lite' ),
'type' => Controls_Manager::SWITCHER,
'label_on' => esc_html__( 'Show', 'wpforms-lite' ),
'label_off' => esc_html__( 'Hide', 'wpforms-lite' ),
'separator' => 'after',
'return_value' => 'yes',
'condition' => [
'form_id!' => '0',
],
]
);
$this->end_controls_section();
}
/**
* Add the notice explaining why the form selector has no options.
*
* A user who may not view forms gets an empty selector for a different reason than a user who
* has no forms yet, so the two states are worded differently.
*
* @since 2.0.1
*
* @noinspection PhpUndefinedMethodInspection
*/
private function add_empty_forms_notice() {
// The no-permission wording is composed of the two sentences the block editor already uses,
// so both surfaces read the same and share their translations.
$notice = $this->current_user_can_view_forms()
? __( '<b>You haven\'t created a form yet.</b><br> What are you waiting for?', 'wpforms-lite' )
: sprintf(
'<b>%1$s</b><br> %2$s',
__( 'You don’t have permission to use WPForms.', 'wpforms-lite' ),
__( 'Contact your site administrator for access.', 'wpforms-lite' )
);
$this->add_control(
'add_form_notice',
[
'show_label' => false,
'type' => Controls_Manager::RAW_HTML,
'raw' => wp_kses(
$notice,
[
'b' => [],
'br' => [],
]
),
'content_classes' => 'elementor-panel-alert elementor-panel-alert-info wpforms-elementor-no-forms-notice',
]
);
}
/**
* Add legacy styles notice.
*
* @since 1.9.6
*
* @noinspection PhpUndefinedMethodInspection
* @noinspection HtmlUnknownTarget
*/
private function add_legacy_styles_notice() {
$is_modern = wpforms_get_render_engine() === 'modern';
$is_full_styles = (int) wpforms_setting( 'disable-css', '1' ) === 1;
if ( ! $is_modern || ! $is_full_styles ) {
$notice_text = ! $is_modern
? __( 'Upgrade your forms to use our modern markup and unlock extensive style controls.', 'wpforms-lite' )
: __( 'Update your forms to use base and form theme styling and unlock extensive style controls.', 'wpforms-lite' );
$this->add_control(
'legacy_styling_notice',
[
'show_label' => false,
'type' => Controls_Manager::RAW_HTML,
'raw' => sprintf(
wp_kses( /* translators: %s - WPForms documentation link. */
__( '<b>Want to customize your form styles without editing CSS?</b> <p>%1$s</p> <a href="%2$s" target="_blank" rel="noopener noreferrer">Learn more</a>', 'wpforms-lite' ),
[
'b' => [],
'p' => [],
'a' => [
'href' => [],
'rel' => [],
'target' => [],
],
]
),
$notice_text,
wpforms_utm_link( 'https://wpforms.com/docs/styling-your-forms/', 'Elementor Widget Settings', 'Form Styles Documentation' )
),
'content_classes' => 'elementor-panel-alert elementor-panel-alert-warning wpforms-legacy-styles-notice',
]
);
}
}
/**
* Render widget output.
*
* @since 1.6.2
*/
protected function render() {
if ( Plugin::$instance->editor->is_edit_mode() ) {
$this->render_edit_mode();
} else {
$this->render_frontend();
}
}
/**
* Render widget output in edit mode.
*
* @since 1.6.3.1
*
* @noinspection PhpPossiblePolymorphicInvocationInspection
*/
protected function render_edit_mode() {
$form_id = $this->get_settings_for_display( 'form_id' );
// Popup markup template.
echo wpforms_render( 'integrations/elementor/popup' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
if ( count( $this->get_forms() ) < 2 ) {
// No forms block.
echo wpforms_render( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
'integrations/elementor/no-forms',
[
'can_view_forms' => $this->current_user_can_view_forms(),
'can_create_forms' => wpforms_current_user_can( 'create_forms' ),
],
true
);
return;
}
if ( empty( $form_id ) ) {
// Render form selector.
echo wpforms_render( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
'integrations/elementor/form-selector',
[
'forms' => $this->get_form_selector_options(),
],
true
);
return;
}
// Finally, render selected form.
$this->render_frontend();
}
/**
* Render widget output on the frontend.
*
* @since 1.6.3.1
*/
protected function render_frontend() {
// Render selected form.
$this->render_form();
}
/**
* Render widget as plain content.
*
* @since 1.6.2
*/
public function render_plain_content() {
$this->render_form();
}
/**
* Render a form.
*
* @since 1.8.3
*
* @noinspection PhpPossiblePolymorphicInvocationInspection
*/
public function render_form() {
wpforms_display(
$this->get_settings_for_display( 'form_id' ),
$this->get_settings_for_display( 'display_form_name' ) === 'yes',
$this->get_settings_for_display( 'display_form_description' ) === 'yes'
);
}
/**
* Determine whether the current user is entitled to view forms.
*
* Exposed on the widget because the form selector AJAX handler asks the same question before
* answering. See wpforms_current_user_can_view_forms() for the Lite and Pro difference.
*
* @since 2.0.1
*
* @return bool
*/
public function current_user_can_view_forms(): bool {
return wpforms_current_user_can_view_forms();
}
/**
* Get form list.
*
* @since 1.6.2
*
* @returns array Array of forms.
*/
public function get_forms() {
static $forms_list = [];
// This runs from the editor preview iframe and from admin-ajax, where the Pro owner-scoping
// filter ( wpforms_get_multiple_forms_args ) is not registered because the request's HTTP
// referer is not an admin one. Authorize and scope explicitly so the list never depends on
// a client-controlled header. The capability check precedes the memo because the memo is
// process-wide and not keyed by user.
if ( ! $this->current_user_can_view_forms() ) {
return [];
}
if ( ! empty( $forms_list ) ) {
return $forms_list;
}
// Reproduce the owner scoping the Pro filter would apply, since it is not registered here.
$args = wpforms_get_viewable_forms_args();
$forms_obj = wpforms()->obj( 'form' );
$forms = $forms_obj ? $forms_obj->get( '', $args ) : null;
if ( ! empty( $forms ) ) {
$forms_list[0] = esc_html__( 'Select a form', 'wpforms-lite' );
foreach ( $forms as $form ) {
$forms_list[ $form->ID ] = mb_strlen( $form->post_title ) > 100 ? mb_substr( $form->post_title, 0, 97 ) . '...' : $form->post_title;
}
}
return $forms_list;
}
/**
* Get form selector options.
*
* @since 1.6.2
*
* @returns string Rendered options for the select tag.
*/
public function get_form_selector_options() {
$forms = $this->get_forms();
$options = '';
foreach ( $forms as $form_id => $form ) {
$options .= sprintf(
'<option value="%d">%s</option>',
(int) $form_id,
esc_html( $form )
);
}
return $options;
}
}