eduling', 'upgrade' => __( 'Form scheduling settings', 'formidable' ), 'screenshot' => 'scheduling.png', ), ), 'buttons' => array( 'name' => __( 'Buttons', 'formidable' ), 'class' => __CLASS__, 'function' => 'buttons_settings', 'icon' => 'frm_icon_font frm_button_icon', ), 'landing' => array( 'name' => __( 'Form Landing Page', 'formidable' ), 'icon' => 'frm_icon_font frm_file_text_icon', 'html_class' => 'frm_show_upgrade_tab frm_noallow', 'data' => FrmAppHelper::get_landing_page_upgrade_data_params(), ), 'chat' => array( 'name' => __( 'Conversational Forms', 'formidable' ), 'icon' => 'frm_icon_font frm_chat_forms_icon', 'html_class' => 'frm_show_upgrade_tab frm_noallow', 'data' => FrmAppHelper::get_upgrade_data_params( 'chat', array( 'upgrade' => __( 'Conversational Forms', 'formidable' ), 'message' => __( 'Ask one question at a time for automated conversations.', 'formidable' ), 'screenshot' => 'chat.png', ) ), ), 'html' => array( 'name' => __( 'Customize HTML', 'formidable' ), 'class' => __CLASS__, 'function' => 'html_settings', 'icon' => 'frm_icon_font frm_code_icon', ), ); foreach ( array( 'landing', 'chat' ) as $feature ) { if ( ! FrmAppHelper::show_new_feature( $feature ) ) { unset( $sections[ $feature ] ); } } $sections = apply_filters( 'frm_add_form_settings_section', $sections, $values ); if ( FrmAppHelper::pro_is_installed() && ! FrmAppHelper::meets_min_pro_version( '4.0' ) ) { // Prevent settings from showing in 2 spots. unset( $sections['permissions'], $sections['scheduling'] ); } foreach ( $sections as $key => $section ) { $defaults = array( 'html_class' => '', 'name' => ucfirst( $key ), 'icon' => 'frm_icon_font frm_settings_icon', ); $section = array_merge( $defaults, $section ); if ( ! isset( $section['anchor'] ) ) { $section['anchor'] = $key; } $section['anchor'] .= '_settings'; if ( ! isset( $section['title'] ) ) { $section['title'] = $section['name']; } if ( ! isset( $section['id'] ) ) { $section['id'] = $section['anchor']; } $sections[ $key ] = $section; } return $sections; } /** * @since 4.0 * * @param array $values */ public static function advanced_settings( $values ) { $first_h3 = 'frm_first_h3'; include FrmAppHelper::plugin_path() . '/classes/views/frm-forms/settings-advanced.php'; } /** * @param array $values */ public static function render_spam_settings( $values ) { if ( function_exists( 'akismet_http_post' ) ) { include FrmAppHelper::plugin_path() . '/classes/views/frm-forms/spam-settings/akismet.php'; } include FrmAppHelper::plugin_path() . '/classes/views/frm-forms/spam-settings/honeypot.php'; include FrmAppHelper::plugin_path() . '/classes/views/frm-forms/spam-settings/antispam.php'; } /** * @since 4.0 * * @param array $values */ public static function buttons_settings( $values ) { $styles = apply_filters( 'frm_get_style_opts', array() ); $frm_settings = FrmAppHelper::get_settings(); $no_global_style = $frm_settings->load_style === 'none'; include( FrmAppHelper::plugin_path() . '/classes/views/frm-forms/settings-buttons.php' ); } /** * @since 4.0 * * @param array $values */ public static function html_settings( $values ) { include( FrmAppHelper::plugin_path() . '/classes/views/frm-forms/settings-html.php' ); } /** * Replace old Submit Button href with new href to avoid errors in Chrome * * @since 2.03.08 * * @param array|boolean $values */ private static function clean_submit_html( &$values ) { if ( is_array( $values ) && isset( $values['submit_html'] ) ) { $values['submit_html'] = str_replace( 'javascript:void(0)', '#', $values['submit_html'] ); } } /** * Updates classes used in submit and prev buttons to avoid conflict with twenty twenty-one theme. * * @param array $classes * * @return array */ public static function update_button_classes( $classes ) { if ( function_exists( 'twenty_twenty_one_setup' ) ) { $classes[] = 'has-text-color has-background'; } return $classes; } public static function mb_tags_box( $form_id, $class = '' ) { $fields = FrmField::get_all_for_form( $form_id, '', 'include' ); /** * Allows modifying the list of fields in the tags box. * * @since 5.0.04 * * @param array $fields The list of fields. * @param array $args The arguments. Contains `form_id`. */ $fields = apply_filters( 'frm_fields_in_tags_box', $fields, compact( 'form_id' ) ); $linked_forms = array(); $col = 'one'; $settings_tab = FrmAppHelper::is_admin_page( 'formidable' ) ? true : false; $cond_shortcodes = apply_filters( 'frm_conditional_shortcodes', array() ); $entry_shortcodes = self::get_shortcode_helpers( $settings_tab ); $advanced_helpers = self::advanced_helpers( compact( 'fields', 'form_id' ) ); include( FrmAppHelper::plugin_path() . '/classes/views/shared/mb_adv_info.php' ); } /** * @since 3.04.01 */ private static function advanced_helpers( $atts ) { $advanced_helpers = array( 'default' => array( 'heading' => __( 'Customize field values with the following parameters.', 'formidable' ), 'codes' => self::get_advanced_shortcodes(), ), ); $user_fields = self::user_shortcodes(); if ( ! empty( $user_fields ) ) { $user_helpers = array(); foreach ( $user_fields as $uk => $uf ) { $user_helpers[ '|user_id| show="' . $uk . '"' ] = $uf; unset( $uk, $uf ); } $advanced_helpers['user_id'] = array( 'codes' => $user_helpers, ); } /** * Add extra helper shortcodes on the Advanced tab in form settings and views * * @since 3.04.01 * * @param array $advanced_helpers * @param array $atts - Includes fields and form_id */ return apply_filters( 'frm_advanced_helpers', $advanced_helpers, $atts ); } /** * Get an array of the options to display in the advanced tab * of the customization panel * * @since 2.0.6 */ private static function get_advanced_shortcodes() { $adv_shortcodes = array( 'x sep=", "' => array( 'label' => __( 'Separator', 'formidable' ), 'title' => __( 'Use a different separator for checkbox fields', 'formidable' ), ), 'x format="d-m-Y"' => array( 'label' => __( 'Date Format', 'formidable' ), ), 'x show="field_label"' => array( 'label' => __( 'Field Label', 'formidable' ), ), 'x wpautop=0' => array( 'label' => __( 'No Auto P', 'formidable' ), 'title' => __( 'Do not automatically add any paragraphs or line breaks', 'formidable' ), ), ); $adv_shortcodes = apply_filters( 'frm_advanced_shortcodes', $adv_shortcodes ); // __( 'Leave blank instead of defaulting to User Login', 'formidable' ) : blank=1 return $adv_shortcodes; } /** * @since 3.04.01 */ private static function user_shortcodes() { $options = array( 'ID' => __( 'User ID', 'formidable' ), 'first_name' => __( 'First Name', 'formidable' ), 'last_name' => __( 'Last Name', 'formidable' ), 'display_name' => __( 'Display Name', 'formidable' ), 'user_login' => __( 'User Login', 'formidable' ), 'user_email' => __( 'Email', 'formidable' ), 'avatar' => __( 'Avatar', 'formidable' ), 'author_link' => __( 'Author Link', 'formidable' ), ); return apply_filters( 'frm_user_shortcodes', $options ); } /** * Get an array of the helper shortcodes to display in the customization panel * * @since 2.0.6 */ private static function get_shortcode_helpers( $settings_tab ) { $entry_shortcodes = array( 'id' => __( 'Entry ID', 'formidable' ), 'key' => __( 'Entry Key', 'formidable' ), 'post_id' => __( 'Post ID', 'formidable' ), 'ip' => __( 'User IP', 'formidable' ), 'created-at' => __( 'Entry created', 'formidable' ), 'updated-at' => __( 'Entry updated', 'formidable' ), '' => '', 'siteurl' => __( 'Site URL', 'formidable' ), 'sitename' => __( 'Site Name', 'formidable' ), ); if ( ! FrmAppHelper::pro_is_installed() ) { unset( $entry_shortcodes['post_id'] ); } if ( $settings_tab ) { $entry_shortcodes['default-message'] = __( 'Default Msg', 'formidable' ); $entry_shortcodes['default-html'] = __( 'Default HTML', 'formidable' ); $entry_shortcodes['default-plain'] = __( 'Default Plain', 'formidable' ); $entry_shortcodes['form_name'] = __( 'Form Name', 'formidable' ); } /** * Use this hook to add or remove buttons in the helpers section * in the customization panel * * @since 2.0.6 */ $entry_shortcodes = apply_filters( 'frm_helper_shortcodes', $entry_shortcodes, $settings_tab ); return $entry_shortcodes; } /** * Insert the form class setting into the form. * * @param stdClass $form * @return void */ public static function form_classes( $form ) { if ( isset( $form->options['form_class'] ) ) { echo esc_attr( sanitize_text_field( $form->options['form_class'] ) ); } if ( ! empty( $form->options['js_validate'] ) ) { echo ' frm_js_validate '; self::add_js_validate_form_to_global_vars( $form ); } if ( ! FrmFormsHelper::should_use_pro_for_ajax_submit() && FrmForm::is_ajax_on( $form ) ) { echo ' frm_ajax_submit '; } } /** * @since 5.0.03 * * @param stdClass $form */ public static function add_js_validate_form_to_global_vars( $form ) { global $frm_vars; if ( ! isset( $frm_vars['js_validate_forms'] ) ) { $frm_vars['js_validate_forms'] = array(); } $frm_vars['js_validate_forms'][ $form->id ] = $form; } public static function get_email_html() { FrmAppHelper::permission_check( 'frm_view_forms' ); check_ajax_referer( 'frm_ajax', 'nonce' ); echo FrmEntriesController::show_entry_shortcode( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped array( 'form_id' => FrmAppHelper::get_post_param( 'form_id', '', 'absint' ), 'default_email' => true, 'plain_text' => FrmAppHelper::get_post_param( 'plain_text', '', 'absint' ), ) ); wp_die(); } /** * @param string $content * @param stdClass|string|int $form * @param stdClass|string|int|false $entry * @return string */ public static function filter_content( $content, $form, $entry = false ) { $content = self::replace_form_name_shortcodes( $content, $form ); self::get_entry_by_param( $entry ); if ( ! $entry ) { return $content; } if ( is_object( $form ) ) { $form = $form->id; } $shortcodes = FrmFieldsHelper::get_shortcodes( $content, $form ); $content = apply_filters( 'frm_replace_content_shortcodes', $content, $entry, $shortcodes ); return $content; } /** * Replace any [form_name] shortcodes in a string. * * @since 5.5 * * @param string|array $string * @param stdClass|string|int $form * @return string|array */ public static function replace_form_name_shortcodes( $string, $form ) { if ( ! is_string( $string ) ) { return $string; } if ( false === strpos( $string, '[form_name]' ) ) { return $string; } if ( ! is_object( $form ) ) { $form = FrmForm::getOne( $form ); } $form_name = is_object( $form ) ? $form->name : ''; return str_replace( '[form_name]', $form_name, $string ); } /** * @param stdClass|string|int|false $entry * @return void */ private static function get_entry_by_param( &$entry ) { if ( ! $entry || ! is_object( $entry ) ) { if ( ! $entry || ! is_numeric( $entry ) ) { $entry = FrmAppHelper::get_post_param( 'id', false, 'sanitize_title' ); } FrmEntry::maybe_get_entry( $entry ); } } public static function replace_content_shortcodes( $content, $entry, $shortcodes ) { return FrmFieldsHelper::replace_content_shortcodes( $content, $entry, $shortcodes ); } public static function process_bulk_form_actions( $errors ) { if ( ! $_REQUEST ) { return $errors; } $bulkaction = FrmAppHelper::get_param( 'action', '', 'get', 'sanitize_text_field' ); if ( $bulkaction == - 1 ) { $bulkaction = FrmAppHelper::get_param( 'action2', '', 'get', 'sanitize_title' ); } if ( ! empty( $bulkaction ) && strpos( $bulkaction, 'bulk_' ) === 0 ) { FrmAppHelper::remove_get_action(); $bulkaction = str_replace( 'bulk_', '', $bulkaction ); } $ids = FrmAppHelper::get_param( 'item-action', '', 'get', 'sanitize_text_field' ); if ( empty( $ids ) ) { $errors[] = __( 'No forms were specified', 'formidable' ); return $errors; } $permission_error = FrmAppHelper::permission_nonce_error( '', '_wpnonce', 'bulk-toplevel_page_formidable' ); if ( $permission_error !== false ) { $errors[] = $permission_error; return $errors; } if ( ! is_array( $ids ) ) { $ids = explode( ',', $ids ); } switch ( $bulkaction ) { case 'delete': $message = self::bulk_destroy( $ids ); break; case 'trash': $message = self::bulk_trash( $ids ); break; case 'untrash': $message = self::bulk_untrash( $ids ); } if ( isset( $message ) && ! empty( $message ) ) { $errors['message'] = $message; } return $errors; } public static function route() { $action = isset( $_REQUEST['frm_action'] ) ? 'frm_action' : 'action'; $vars = array(); FrmAppHelper::include_svg(); if ( isset( $_POST['frm_compact_fields'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing FrmAppHelper::permission_check( 'frm_edit_forms' ); // Javascript needs to be allowed in some field settings. // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.NonceVerification.Missing $json_vars = htmlspecialchars_decode( nl2br( str_replace( '"', '"', wp_unslash( $_POST['frm_compact_fields'] ) ) ) ); $json_vars = json_decode( $json_vars, true ); if ( empty( $json_vars ) ) { // json decoding failed so we should return an error message. $action = FrmAppHelper::get_param( $action, '', 'get', 'sanitize_title' ); if ( 'edit' == $action ) { $action = 'update'; } add_filter( 'frm_validate_form', 'FrmFormsController::json_error' ); } else { $vars = FrmAppHelper::json_to_array( $json_vars ); $action = $vars[ $action ]; unset( $_REQUEST['frm_compact_fields'], $_POST['frm_compact_fields'] ); // phpcs:ignore WordPress.Security.NonceVerification.Missing $_REQUEST = array_merge( $_REQUEST, $vars ); // phpcs:ignore WordPress.Security.NonceVerification.Missing $_POST = array_merge( $_POST, $_REQUEST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing } } else { $action = FrmAppHelper::get_param( $action, '', 'get', 'sanitize_title' ); if ( isset( $_REQUEST['delete_all'] ) ) { // Override the action for this page. $action = 'delete_all'; } } add_action( 'frm_load_form_hooks', 'FrmHooksController::trigger_load_form_hooks' ); FrmAppHelper::trigger_hook_load( 'form' ); switch ( $action ) { case 'new': return self::new_form( $vars ); case 'create': case 'edit': case 'update': case 'trash': case 'untrash': case 'destroy': case 'delete_all': case 'settings': case 'update_settings': return self::$action( $vars ); case 'lite-reports': return self::no_reports( $vars ); case 'views': return self::no_views( $vars ); default: do_action( 'frm_form_action_' . $action ); if ( apply_filters( 'frm_form_stop_action_' . $action, false ) ) { return; } $action = FrmAppHelper::get_param( 'action', '', 'get', 'sanitize_text_field' ); if ( $action == - 1 ) { $action = FrmAppHelper::get_param( 'action2', '', 'get', 'sanitize_title' ); } if ( strpos( $action, 'bulk_' ) === 0 ) { FrmAppHelper::remove_get_action(); self::list_form(); return; } $message = FrmAppHelper::get_param( 'message' ); if ( 'form_duplicate_error' === $message ) { self::display_forms_list( array(), '', array( __( 'There was a problem duplicating the form', 'formidable' ) ) ); return; } self::display_forms_list(); return; } } public static function json_error( $errors ) { $errors['json'] = __( 'Abnormal HTML characters prevented your form from saving correctly', 'formidable' ); return $errors; } /** * Education for premium features. * * @since 4.05 */ public static function add_form_style_tab_options() { include( FrmAppHelper::plugin_path() . '/classes/views/frm-forms/add_form_style_options.php' ); } /** * Add education about views. * * @since 4.07 */ public static function no_views( $values = array() ) { FrmAppHelper::include_svg(); $id = FrmAppHelper::get_param( 'form', '', 'get', 'absint' ); $form = $id ? FrmForm::getOne( $id ) : false; include FrmAppHelper::plugin_path() . '/classes/views/shared/views-info.php'; } /** * Add education about reports. * * @since 4.07 */ public static function no_reports( $values = array() ) { $id = FrmAppHelper::get_param( 'form', '', 'get', 'absint' ); $form = $id ? FrmForm::getOne( $id ) : false; include FrmAppHelper::plugin_path() . '/classes/views/shared/reports-info.php'; } /* FRONT-END FORMS */ public static function admin_bar_css() { if ( is_admin() || ! current_user_can( 'frm_edit_forms' ) ) { return; } self::move_menu_to_footer(); add_action( 'wp_before_admin_bar_render', 'FrmFormsController::admin_bar_configure' ); FrmAppHelper::load_font_style(); } /** * @since 4.05.02 */ private static function move_menu_to_footer() { $settings = FrmAppHelper::get_settings(); if ( empty( $settings->admin_bar ) ) { remove_action( 'wp_body_open', 'wp_admin_bar_render', 0 ); } } public static function admin_bar_configure() { global $frm_vars; if ( empty( $frm_vars['forms_loaded'] ) ) { return; } $actions = array(); foreach ( $frm_vars['forms_loaded'] as $form ) { if ( is_object( $form ) ) { $actions[ $form->id ] = $form->name; } unset( $form ); } if ( empty( $actions ) ) { return; } self::add_menu_to_admin_bar(); self::add_forms_to_admin_bar( $actions ); } /** * @since 2.05.07 */ public static function add_menu_to_admin_bar() { global $wp_admin_bar; $wp_admin_bar->add_node( array( 'id' => 'frm-forms', 'title' => '' . FrmAppHelper::get_menu_name() . '', 'href' => admin_url( 'admin.php?page=formidable' ), 'meta' => array( 'title' => FrmAppHelper::get_menu_name(), ), ) ); } /** * @since 2.05.07 */ private static function add_forms_to_admin_bar( $actions ) { global $wp_admin_bar; asort( $actions ); foreach ( $actions as $form_id => $name ) { $wp_admin_bar->add_node( array( 'parent' => 'frm-forms', 'id' => 'edit_form_' . $form_id, 'title' => empty( $name ) ? __( '(no title)', 'formidable' ) : $name, 'href' => FrmForm::get_edit_link( $form_id ), ) ); } } /** * The formidable shortcode * * @param array $atts The params from the shortcode. * @return string */ public static function get_form_shortcode( $atts ) { global $frm_vars; if ( isset( $frm_vars['skip_shortcode'] ) && $frm_vars['skip_shortcode'] ) { $sc = '[formidable'; $sc .= FrmAppHelper::array_to_html_params( $atts ); return $sc . ']'; } $shortcode_atts = shortcode_atts( array( 'id' => '', 'key' => '', 'title' => 'auto', 'description' => 'auto', 'readonly' => false, 'entry_id' => false, 'fields' => array(), 'exclude_fields' => array(), 'minimize' => false, ), $atts ); do_action( 'formidable_shortcode_atts', $shortcode_atts, $atts ); return self::show_form( $shortcode_atts['id'], $shortcode_atts['key'], $shortcode_atts['title'], $shortcode_atts['description'], $atts ); } /** * @since 5.2.01 * * @param string|int|false $id * @param string|false $key * @return stdClass|false */ private static function maybe_get_form_by_id_or_key( $id, $key ) { if ( ! $id ) { $id = $key; } return self::maybe_get_form_to_show( $id ); } /** * @param string|int|false $id * @param string|false $key * @param string|int|bool $title may be 'auto', true, false, 'true', 'false', 'yes', '1', 1, '0', 0. * @param string|int|bool $description may be 'auto', true, false, 'true', 'false', 'yes', '1', 1, '0', 0. * @param array $atts * @return string */ public static function show_form( $id = '', $key = '', $title = false, $description = false, $atts = array() ) { $form = self::maybe_get_form_by_id_or_key( $id, $key ); if ( ! $form ) { return __( 'Please select a valid form', 'formidable' ); } if ( 'auto' === $title ) { $title = ! empty( $form->options['show_title'] ); } if ( 'auto' === $description ) { $description = ! empty( $form->options['show_description'] ); } FrmAppController::maybe_update_styles(); add_action( 'frm_load_form_hooks', 'FrmHooksController::trigger_load_form_hooks' ); FrmAppHelper::trigger_hook_load( 'form', $form ); $form = apply_filters( 'frm_pre_display_form', $form ); $frm_settings = FrmAppHelper::get_settings( array( 'current_form' => $form->id ) ); if ( self::is_viewable_draft_form( $form ) ) { // don't show a draft form on a page $form = __( 'Please select a valid form', 'formidable' ); } elseif ( ! FrmForm::is_visible_to_user( $form ) ) { $form = do_shortcode( $frm_settings->login_msg ); } else { do_action( 'frm_pre_get_form', $form ); $form = self::get_form( $form, $title, $description, $atts ); /** * Use this shortcode to check for external shortcodes that may span * across multiple fields in the customizable HTML * * @since 2.0.8 */ $form = apply_filters( 'frm_filter_final_form', $form ); } return $form; } /** * @param string|int|false $id * @return stdClass|false */ private static function maybe_get_form_to_show( $id ) { $form = false; if ( ! empty( $id ) ) { // form id or key is set $form = FrmForm::getOne( $id ); if ( ! $form || $form->parent_form_id || $form->status === 'trash' ) { $form = false; } } return $form; } private static function is_viewable_draft_form( $form ) { return $form->status === 'draft' && current_user_can( 'frm_edit_forms' ) && ! FrmAppHelper::is_preview_page(); } public static function get_form( $form, $title, $description, $atts = array() ) { ob_start(); do_action( 'frm_before_get_form', $atts ); self::get_form_contents( $form, $title, $description, $atts ); self::enqueue_scripts( FrmForm::get_params( $form ) ); $contents = ob_get_contents(); ob_end_clean(); self::maybe_minimize_form( $atts, $contents ); return $contents; } public static function enqueue_scripts( $params ) { do_action( 'frm_enqueue_form_scripts', $params ); } public static function get_form_contents( $form, $title, $description, $atts ) { $params = FrmForm::get_params( $form ); $errors = self::get_saved_errors( $form, $params ); $fields = FrmFieldsHelper::get_form_fields( $form->id, $errors ); $reset = false; $pass_args = compact( 'form', 'fields', 'errors', 'title', 'description', 'reset' ); $pass_args['action'] = $params['action']; $handle_process_here = $params['action'] === 'create' && $params['posted_form_id'] == $form->id && $_POST; // phpcs:ignore WordPress.Security.NonceVerification.Missing if ( ! $handle_process_here ) { FrmFormState::set_initial_value( 'title', $title ); FrmFormState::set_initial_value( 'description', $description ); do_action( 'frm_display_form_action', $params, $fields, $form, $title, $description ); if ( apply_filters( 'frm_continue_to_new', true, $form->id, $params['action'] ) ) { self::show_form_after_submit( $pass_args ); } } elseif ( ! empty( $errors ) ) { self::show_form_after_submit( $pass_args ); } else { do_action( 'frm_validate_form_creation', $params, $fields, $form, $title, $description ); if ( apply_filters( 'frm_continue_to_create', true, $form->id ) ) { $entry_id = self::just_created_entry( $form->id ); $pass_args['entry_id'] = $entry_id; $pass_args['reset'] = true; self::run_on_submit_actions( $pass_args ); do_action( 'frm_after_entry_processed', array( 'entry_id' => $entry_id, 'form' => $form, ) ); } } } /** * If the form was processed earlier (init), get the generated errors * * @since 2.05 */ private static function get_saved_errors( $form, $params ) { global $frm_vars; if ( $params['posted_form_id'] == $form->id && $_POST && isset( $frm_vars['created_entries'][ $form->id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing $errors = $frm_vars['created_entries'][ $form->id ]['errors']; } else { $errors = array(); } /** * Allows modifying the generated errors if the form was processed earlier. * * @since 5.2.03 * * @param array $errors Errors data. Is empty array if no errors found. * @param array $params Form params. See {@see FrmForm::get_params()}. */ return apply_filters( 'frm_saved_errors', $errors, $params ); } /** * @since 2.2.7 */ public static function just_created_entry( $form_id ) { global $frm_vars; return ( isset( $frm_vars['created_entries'] ) && isset( $frm_vars['created_entries'][ $form_id ] ) && isset( $frm_vars['created_entries'][ $form_id ]['entry_id'] ) ) ? $frm_vars['created_entries'][ $form_id ]['entry_id'] : 0; } /** * Gets confirmation method. * * @since 3.0 * @since 6.0 This method can return an array of met On Submit actions. * * @param array $atts { * Atts. * * @type object $form Form object. * @type int $entry_id Entry ID. * } * @return string|array */ private static function get_confirmation_method( $atts ) { $action = FrmOnSubmitHelper::current_event( $atts ); $opt = 'update' === $action ? 'edit_action' : 'success_action'; $method = ( isset( $atts['form']->options[ $opt ] ) && ! empty( $atts['form']->options[ $opt ] ) ) ? $atts['form']->options[ $opt ] : 'message'; if ( ! empty( $atts['entry_id'] ) ) { $met_actions = self::get_met_on_submit_actions( $atts, $action ); if ( $met_actions ) { $method = $met_actions; } } $method = apply_filters( 'frm_success_filter', $method, $atts['form'], $action ); if ( $method != 'message' && ( ! $atts['entry_id'] || ! is_numeric( $atts['entry_id'] ) ) ) { $method = 'message'; } return $method; } public static function maybe_trigger_redirect( $form, $params, $args ) { if ( ! isset( $params['id'] ) ) { global $frm_vars; $params['id'] = $frm_vars['created_entries'][ $form->id ]['entry_id']; } $conf_method = self::get_confirmation_method( array( 'form' => $form, 'entry_id' => $params['id'], 'action' => FrmOnSubmitHelper::current_event( $params ), ) ); self::maybe_trigger_redirect_with_action( $conf_method, $form, $params, $args ); } /** * Maybe trigger redirect with the new Confirmation action. * * @since 6.1.1 * * @param array|string $conf_method Array of confirmation actions or the action type string. * @param object $form Form object. * @param array $params See {@see FrmFormsController::maybe_trigger_redirect()}. * @param array $args See {@see FrmFormsController::maybe_trigger_redirect()}. */ public static function maybe_trigger_redirect_with_action( $conf_method, $form, $params, $args ) { if ( is_array( $conf_method ) && 1 === count( $conf_method ) ) { if ( 'redirect' === FrmOnSubmitHelper::get_action_type( $conf_method[0] ) ) { $event = FrmOnSubmitHelper::current_event( $params ); FrmOnSubmitHelper::populate_on_submit_data( $form->options, $conf_method[0], $event ); $conf_method = 'redirect'; } } if ( 'redirect' === $conf_method ) { self::trigger_redirect( $form, $params, $args ); } } public static function trigger_redirect( $form, $params, $args ) { $success_args = array( 'action' => $params['action'], 'conf_method' => 'redirect', 'form' => $form, 'entry_id' => $params['id'], ); if ( isset( $args['ajax'] ) ) { $success_args['ajax'] = $args['ajax']; } self::run_success_action( $success_args ); } /** * Used when the success action is not 'message' * * @since 2.05 * @since 6.0 `$args['force_delay_redirect']` is added. * * @param array $args { * The args. * * @type string $conf_method The method. * @type object $form Form object. * @type int $entry_id Entry ID. * @type string $action The action event. Accepts `create` or `update`. * @type array $fields The array of fields. * @type int $force_delay_redirect Force to show the message before redirecting in case redirect method runs. * } */ public static function run_success_action( $args ) { global $frm_vars; $extra_args = $args; unset( $extra_args['form'] ); do_action( 'frm_success_action', $args['conf_method'], $args['form'], $args['form']->options, $args['entry_id'], $extra_args ); $opt = ( ! isset( $args['action'] ) || $args['action'] === 'create' ) ? 'success' : 'edit'; $args['success_opt'] = $opt; $args['ajax'] = ! empty( $frm_vars['ajax'] ); if ( $args['conf_method'] === 'page' && is_numeric( $args['form']->options[ $opt . '_page_id' ] ) ) { self::load_page_after_submit( $args ); } elseif ( $args['conf_method'] === 'redirect' ) { self::redirect_after_submit( $args ); } else { self::show_message_after_save( $args ); } } /** * Gets met On Submit actions. * * @since 6.0 * * @param array $args See {@see FrmFormsController::run_success_action()}. * @param string $event Form event. Default is `create`. * @return array Array of actions that meet the conditional logics. */ public static function get_met_on_submit_actions( $args, $event = 'create' ) { if ( ! FrmOnSubmitHelper::form_has_migrated( $args['form'] ) ) { return array(); } // If a redirect action has already opened the URL in a new tab, we show the default message in the currect tab. if ( ! empty( self::$redirected_in_new_tab[ $args['form']->id ] ) ) { return array( FrmOnSubmitHelper::get_fallback_action_after_open_in_new_tab( $event ) ); } $entry = FrmEntry::getOne( $args['entry_id'], true ); $actions = FrmOnSubmitHelper::get_actions( $args['form']->id ); $met_actions = array(); $has_redirect = false; foreach ( $actions as $action ) { if ( ! in_array( $event, $action->post_content['event'], true ) ) { continue; } if ( FrmFormAction::action_conditions_met( $action, $entry ) ) { continue; } $action_type = FrmOnSubmitHelper::get_action_type( $action ); if ( 'redirect' === $action_type ) { if ( $has_redirect ) { // Do not process because we run the first redirect action only. continue; } } if ( ! self::is_valid_on_submit_action( $action, $args, $event ) ) { continue; } if ( 'redirect' === $action_type ) { $has_redirect = true; } $met_actions[] = $action; unset( $action ); } $args['event'] = $event; /** * Filters the On Submit actions that meet the conditional logics. * * @since 6.0 * * @param array $met_actions Actions that meet the conditional logics. * @param array $args See {@see FrmFormsController::run_success_action()}. `$args['event']` is also added. */ $met_actions = apply_filters( 'frm_get_met_on_submit_actions', $met_actions, $args ); if ( empty( $met_actions ) ) { $met_actions = array( FrmOnSubmitHelper::get_fallback_action( $event ) ); } return $met_actions; } /** * Checks if a Confirmation action has the valid data. * * @since 6.1.2 * * @param object $action Form action object. * @param array $args See {@see FrmFormsController::run_success_action()}. * @param string $event Form event. Default is `create`. * @return bool */ private static function is_valid_on_submit_action( $action, $args, $event = 'create' ) { $action_type = FrmOnSubmitHelper::get_action_type( $action ); if ( 'redirect' === $action_type ) { // Run through frm_redirect_url filter. This is used for the valid action check. $action->post_content['success_url'] = apply_filters( 'frm_redirect_url', $action->post_content['success_url'], $args['form'], $args + array( 'action' => $event ) ); return ! empty( $action->post_content['success_url'] ); } if ( 'page' === $action_type ) { if ( empty( $action->post_content['success_page_id'] ) ) { return false; } $page = get_post( $action->post_content['success_page_id'] ); if ( ! $page || 'trash' === $page->post_status ) { return false; } } return true; } /** * Runs On Submit actions. * * @since 6.0 * * @param array $args See inside {@see FrmFormsController::get_form_contents()} method. */ public static function run_on_submit_actions( $args ) { $args['conf_method'] = self::get_confirmation_method( array( 'form' => $args['form'], 'entry_id' => $args['entry_id'], 'action' => FrmOnSubmitHelper::current_event( $args ), ) ); if ( ! is_array( $args['conf_method'] ) ) { self::run_success_action( $args ); return; } // If conf_method is an array, run On Submit actions. if ( ! $args['conf_method'] ) { // Use default message. FrmOnSubmitHelper::populate_on_submit_data( $args['form']->options ); self::run_success_action( $args ); } elseif ( 1 === count( $args['conf_method'] ) ) { FrmOnSubmitHelper::populate_on_submit_data( $args['form']->options, reset( $args['conf_method'] ) ); $args['conf_method'] = $args['form']->options['success_action']; self::run_success_action( $args ); } else { self::run_multi_on_submit_actions( $args ); } } /** * Runs multiple success actions. * * @since 6.0 * * @param array $args See {@see FrmFormsController::run_success_action()}. */ public static function run_multi_on_submit_actions( $args ) { $redirect_action = null; foreach ( $args['conf_method'] as $action ) { if ( 'redirect' === FrmOnSubmitHelper::get_action_type( $action ) ) { // We catch the redirect action to run it last. $redirect_action = $action; continue; } self::run_single_on_submit_action( $args, $action ); unset( $action ); } if ( $redirect_action ) { // Show script to delay the redirection. $args['force_delay_redirect'] = true; self::run_single_on_submit_action( $args, $redirect_action ); } } /** * Runs single On Submit action. * * @since 6.0 * * @param array $args See {@see FrmFormsController::run_success_action()}. * @param object $action On Submit action object. */ public static function run_single_on_submit_action( $args, $action ) { $new_args = self::get_run_success_action_args( $args, $action ); self::run_success_action( $new_args ); } /** * Gets run_success_action() args from the On Submit action. * * @since 6.0 * * @param array $args See {@see FrmFormsController::run_success_action()}. * @param object $action On Submit action object. * @return array */ private static function get_run_success_action_args( $args, $action ) { $new_args = $args; FrmOnSubmitHelper::populate_on_submit_data( $new_args['form']->options, $action, $args['action'] ); $opt = 'update' === $args['action'] ? 'edit_' : 'success_'; $new_args['conf_method'] = $new_args['form']->options[ $opt . 'action' ]; /** * Filters the run success action args. * * @since 6.0 * * @param array $new_args The new args. * @param array $args The old args. See {@see FrmFormsController::run_success_action()}. * @param object $action On Submit action object. */ return apply_filters( 'frm_get_run_success_action_args', $new_args, $args, $action ); } /** * @since 3.0 */ private static function load_page_after_submit( $args ) { global $post; $opt = $args['success_opt']; if ( ! $post || $args['form']->options[ $opt . '_page_id' ] != $post->ID ) { $page = get_post( $args['form']->options[ $opt . '_page_id' ] ); $old_post = $post; $post = $page; $content = apply_filters( 'frm_content', $page->post_content, $args['form'], $args['entry_id'] ); // Fix the On Submit page content doesn't show when previewing In theme. $has_preview_filter = has_filter( 'the_content', 'FrmFormsController::preview_content' ); if ( $has_preview_filter ) { remove_filter( 'the_content', 'FrmFormsController::preview_content', 9999 ); } echo apply_filters( 'the_content', $content ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped if ( $has_preview_filter ) { add_filter( 'the_content', 'FrmFormsController::preview_content', 9999 ); } $post = $old_post; } } /** * @since 3.0 * @param array $args See {@see FrmFormsController::run_success_action()}. */ private static function redirect_after_submit( $args ) { add_filter( 'frm_use_wpautop', '__return_false' ); $opt = $args['success_opt']; $success_url = trim( $args['form']->options[ $opt . '_url' ] ); $success_url = apply_filters( 'frm_content', $success_url, $args['form'], $args['entry_id'] ); $success_url = do_shortcode( $success_url ); $args['id'] = $args['entry_id']; FrmEntriesController::delete_entry_before_redirect( $success_url, $args['form'], $args ); add_filter( 'frm_redirect_url', 'FrmEntriesController::prepare_redirect_url' ); $success_url = apply_filters( 'frm_redirect_url', $success_url, $args['form'], $args ); $doing_ajax = FrmAppHelper::doing_ajax(); if ( ! empty( $args['ajax'] ) && $doing_ajax && empty( $args['force_delay_redirect'] ) ) { // Is AJAX submit and there is just one Redirect action runs. echo json_encode( self::get_ajax_redirect_response_data( $args + compact( 'success_url' ) ) ); wp_die(); } if ( ! headers_sent() && empty( $args['force_delay_redirect'] ) ) { // Not AJAX submit, no headers sent, and there is just one Redirect action runs. if ( ! empty( $args['form']->options['open_in_new_tab'] ) ) { self::print_open_in_new_tab_js_with_fallback_handler( $success_url, $args ); self::$redirected_in_new_tab[ $args['form']->id ] = 1; return; } wp_redirect( esc_url_raw( $success_url ) ); die(); // do not use wp_die or redirect fails } // Redirect with a delay. self::redirect_after_submit_using_js( $args + compact( 'success_url', 'doing_ajax' ) ); } /** * Prints open in new tab js with fallback handler. * * @since 6.x * * @param string $success_url Success URL. * @param array $args See {@see FrmFormsController::redirect_after_submit()}. */ private static function print_open_in_new_tab_js_with_fallback_handler( $success_url, $args ) { echo ''; } /** * Gets response data for redirect action when AJAX submitting. * * @since 6.x * * @param array $args See {@see FrmFormsController::run_success_action()}. * @return array */ private static function get_ajax_redirect_response_data( $args ) { $response_data = array( 'redirect' => $args['success_url'] ); if ( ! empty( $args['form']->options['open_in_new_tab'] ) ) { $response_data['openInNewTab'] = 1; $args['message'] = FrmOnSubmitHelper::get_default_new_tab_msg(); $args['form']->options['success_msg'] = $args['message']; $args['form']->options['edit_msg'] = $args['message']; if ( ! isset( $args['fields'] ) ) { $args['fields'] = FrmField::get_all_for_form( $args['form']->id ); } $args['message'] = self::prepare_submit_message( $args['form'], $args['entry_id'], $args ); ob_start(); self::show_lone_success_messsage( $args ); $response_data['content'] = ob_get_clean(); $response_data['fallbackMsg'] = self::get_redirect_fallback_message( $args['success_url'], $args ); } return $response_data; } /** * Redirects after submitting using JS. This is used when showing message before redirecting. * * @since 6.0 * * @param array $args See {@see FrmFormsController::run_success_action()}. */ private static function redirect_after_submit_using_js( $args ) { $success_msg = FrmOnSubmitHelper::get_default_redirect_msg(); $redirect_msg = self::get_redirect_message( $args['success_url'], $success_msg, $args ); $success_url = esc_url_raw( $args['success_url'] ); /** * Filters the delay time before redirecting when On Submit Redirect action is delayed. * * @since 6.0 * * @param int $delay_time Delay time in miliseconds. */ $delay_time = apply_filters( 'frm_redirect_delay_time', 8000 ); if ( ! empty( $args['form']->options['open_in_new_tab'] ) ) { $redirect_js = 'window.open("' . $success_url . '", "_blank")'; } else { $redirect_js = 'window.location="' . $success_url . '";'; } add_filter( 'frm_use_wpautop', '__return_true' ); echo FrmAppHelper::maybe_kses( $redirect_msg ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped echo ''; } /** * @since 3.0 * * @param string $success_url * @param string $success_msg * @param array $args */ private static function get_redirect_message( $success_url, $success_msg, $args ) { $redirect_msg = '