first commit
This commit is contained in:
@@ -0,0 +1,279 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Base form template.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
abstract class WPForms_Template {
|
||||
|
||||
/**
|
||||
* Full name of the template, eg "Contact Form".
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $name;
|
||||
|
||||
/**
|
||||
* Slug of the template, eg "contact-form" - no spaces.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $slug;
|
||||
|
||||
/**
|
||||
* Source of the template.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $source;
|
||||
|
||||
/**
|
||||
* Categories array.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $categories;
|
||||
|
||||
/**
|
||||
* Short description the template.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $description = '';
|
||||
|
||||
/**
|
||||
* Short description of the fields included with the template.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $includes = '';
|
||||
|
||||
/**
|
||||
* URL of the icon to display in the admin area.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $icon = '';
|
||||
|
||||
/**
|
||||
* Array of data that is assigned to the post_content on form creation.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $data;
|
||||
|
||||
/**
|
||||
* Priority to show in the list of available templates.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $priority = 20;
|
||||
|
||||
/**
|
||||
* Core or additional template.
|
||||
*
|
||||
* @since 1.4.0
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $core = false;
|
||||
|
||||
/**
|
||||
* Modal message to display when the template is applied.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $modal = '';
|
||||
|
||||
/**
|
||||
* Primary class constructor.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function __construct() {
|
||||
|
||||
// Bootstrap.
|
||||
$this->init();
|
||||
|
||||
$type = $this->core ? '_core' : '';
|
||||
|
||||
add_filter( "wpforms_form_templates{$type}", [ $this, 'template_details' ], $this->priority );
|
||||
add_filter( 'wpforms_create_form_args', [ $this, 'template_data' ], 10, 2 );
|
||||
add_filter( 'wpforms_save_form_args', [ $this, 'template_replace' ], 10, 3 );
|
||||
add_filter( 'wpforms_builder_template_active', [ $this, 'template_active' ], 10, 2 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Let's get started.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function init() {}
|
||||
|
||||
/**
|
||||
* Add basic template details to the Add New Form admin screen.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param array $templates Templates array.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function template_details( $templates ) {
|
||||
|
||||
$templates[] = [
|
||||
'name' => $this->name,
|
||||
'slug' => $this->slug,
|
||||
'source' => $this->source,
|
||||
'categories' => $this->categories,
|
||||
'description' => $this->description,
|
||||
'includes' => $this->includes,
|
||||
'icon' => $this->icon,
|
||||
'plugin_dir' => $this->get_plugin_dir(),
|
||||
];
|
||||
|
||||
return $templates;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the directory name of the plugin in which current template resides.
|
||||
*
|
||||
* @since 1.6.9
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function get_plugin_dir() {
|
||||
|
||||
$reflection = new \ReflectionClass( $this );
|
||||
$template_file_path = wp_normalize_path( $reflection->getFileName() );
|
||||
|
||||
// Cutting out the WP_PLUGIN_DIR from the beginning of the template file path.
|
||||
$template_file_path = preg_replace( '{^' . wp_slash( wp_normalize_path( WP_PLUGIN_DIR ) ) . '}', '', $template_file_path );
|
||||
|
||||
$template_file_chunks = explode( '/', $template_file_path );
|
||||
|
||||
return $template_file_chunks[1];
|
||||
}
|
||||
|
||||
/**
|
||||
* Add template data when form is created.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param array $args Create form arguments.
|
||||
* @param array $data Template data.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function template_data( $args, $data ) {
|
||||
|
||||
if ( ! empty( $data ) && ! empty( $data['template'] ) ) {
|
||||
if ( $data['template'] === $this->slug ) {
|
||||
|
||||
// Enable Notifications by default.
|
||||
$this->data['settings']['notification_enable'] = isset( $this->data['settings']['notification_enable'] )
|
||||
? $this->data['settings']['notification_enable']
|
||||
: 1;
|
||||
|
||||
$args['post_content'] = wpforms_encode( $this->data );
|
||||
}
|
||||
}
|
||||
|
||||
return $args;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace template on post update if triggered.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param array $form Form post data.
|
||||
* @param array $data Form data.
|
||||
* @param array $args Update form arguments.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function template_replace( $form, $data, $args ) {
|
||||
|
||||
if ( ! empty( $args['template'] ) ) {
|
||||
if ( $args['template'] === $this->slug ) {
|
||||
$new = $this->data;
|
||||
$new['settings'] = ! empty( $form['post_content']['settings'] ) ? $form['post_content']['settings'] : [];
|
||||
$form['post_content'] = wpforms_encode( $new );
|
||||
}
|
||||
}
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pass information about the active template back to the builder.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param array $details Details.
|
||||
* @param object $form Form data.
|
||||
*
|
||||
* @return array|void
|
||||
*/
|
||||
public function template_active( $details, $form ) {
|
||||
|
||||
if ( empty( $form ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$form_data = wpforms_decode( $form->post_content );
|
||||
|
||||
if ( empty( $this->modal ) || empty( $form_data['meta']['template'] ) || $this->slug !== $form_data['meta']['template'] ) {
|
||||
return $details;
|
||||
} else {
|
||||
$display = $this->template_modal_conditional( $form_data );
|
||||
}
|
||||
|
||||
return [
|
||||
'name' => $this->name,
|
||||
'slug' => $this->slug,
|
||||
'description' => $this->description,
|
||||
'includes' => $this->includes,
|
||||
'icon' => $this->icon,
|
||||
'modal' => $this->modal,
|
||||
'modal_display' => $display,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Conditional to determine if the template informational modal screens
|
||||
* should display.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param array $form_data Form data and settings.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function template_modal_conditional( $form_data ) {
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Blank form template.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
class WPForms_Template_Blank extends WPForms_Template {
|
||||
|
||||
/**
|
||||
* Primary class constructor.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function init() {
|
||||
|
||||
$this->priority = 1;
|
||||
$this->name = esc_html__( 'Blank Form', 'wpforms-lite' );
|
||||
$this->slug = 'blank';
|
||||
$this->source = 'wpforms-core';
|
||||
$this->categories = 'all';
|
||||
$this->description = esc_html__( 'The blank form allows you to create any type of form using our drag & drop builder.', 'wpforms-lite' );
|
||||
$this->includes = '';
|
||||
$this->icon = '';
|
||||
$this->modal = '';
|
||||
$this->core = true;
|
||||
$this->data = [
|
||||
'field_id' => '1',
|
||||
'fields' => [],
|
||||
'settings' => [
|
||||
'antispam' => '1',
|
||||
'ajax_submit' => '1',
|
||||
'confirmation_message_scroll' => '1',
|
||||
'submit_text_processing' => esc_html__( 'Sending...', 'wpforms-lite' ),
|
||||
],
|
||||
'meta' => [
|
||||
'template' => $this->slug,
|
||||
],
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
new WPForms_Template_Blank();
|
||||
Reference in New Issue
Block a user