<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Base form template.

[3] Fix | Delete

*

[4] Fix | Delete

* @since 1.0.0

[5] Fix | Delete

*/

[6] Fix | Delete

abstract class WPForms_Template {

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Full name of the template, eg "Contact Form".

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.0.0

[12] Fix | Delete

*

[13] Fix | Delete

* @var string

[14] Fix | Delete

*/

[15] Fix | Delete

public $name;

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Slug of the template, eg "contact-form" - no spaces.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 1.0.0

[21] Fix | Delete

*

[22] Fix | Delete

* @var string

[23] Fix | Delete

*/

[24] Fix | Delete

public $slug;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Source of the template.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 1.6.8

[30] Fix | Delete

*

[31] Fix | Delete

* @var array

[32] Fix | Delete

*/

[33] Fix | Delete

public $source;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Categories array.

[37] Fix | Delete

*

[38] Fix | Delete

* @since 1.6.8

[39] Fix | Delete

*

[40] Fix | Delete

* @var array

[41] Fix | Delete

*/

[42] Fix | Delete

public $categories;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Short description the template.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 1.0.0

[48] Fix | Delete

*

[49] Fix | Delete

* @var string

[50] Fix | Delete

*/

[51] Fix | Delete

public $description = '';

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Short description of the fields included with the template.

[55] Fix | Delete

*

[56] Fix | Delete

* @since 1.0.0

[57] Fix | Delete

*

[58] Fix | Delete

* @var string

[59] Fix | Delete

*/

[60] Fix | Delete

public $includes = '';

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* URL of the icon to display in the admin area.

[64] Fix | Delete

*

[65] Fix | Delete

* @since 1.0.0

[66] Fix | Delete

*

[67] Fix | Delete

* @var string

[68] Fix | Delete

*/

[69] Fix | Delete

public $icon = '';

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Form template preview URL.

[73] Fix | Delete

*

[74] Fix | Delete

* @since 1.7.5.3

[75] Fix | Delete

*

[76] Fix | Delete

* @var string

[77] Fix | Delete

*/

[78] Fix | Delete

public $url = '';

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Form template thumbnail url.

[82] Fix | Delete

*

[83] Fix | Delete

* @since 1.8.2

[84] Fix | Delete

*

[85] Fix | Delete

* @var string

[86] Fix | Delete

*/

[87] Fix | Delete

public $thumbnail = '';

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Array of data that is assigned to the post_content on form creation.

[91] Fix | Delete

*

[92] Fix | Delete

* @since 1.0.0

[93] Fix | Delete

*

[94] Fix | Delete

* @var array

[95] Fix | Delete

*/

[96] Fix | Delete

public $data;

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Priority to show in the list of available templates.

[100] Fix | Delete

*

[101] Fix | Delete

* @since 1.0.0

[102] Fix | Delete

*

[103] Fix | Delete

* @var int

[104] Fix | Delete

*/

[105] Fix | Delete

public $priority = 20;

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Core or additional template.

[109] Fix | Delete

*

[110] Fix | Delete

* @since 1.4.0

[111] Fix | Delete

*

[112] Fix | Delete

* @var bool

[113] Fix | Delete

*/

[114] Fix | Delete

public $core = false;

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Modal message to display when the template is applied.

[118] Fix | Delete

*

[119] Fix | Delete

* @since 1.0.0

[120] Fix | Delete

*

[121] Fix | Delete

* @var array

[122] Fix | Delete

*/

[123] Fix | Delete

public $modal = '';

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Primary class constructor.

[127] Fix | Delete

*

[128] Fix | Delete

* @since 1.0.0

[129] Fix | Delete

*/

[130] Fix | Delete

public function __construct() {

[131] Fix | Delete

[132] Fix | Delete

// Bootstrap.

[133] Fix | Delete

$this->init();

[134] Fix | Delete

[135] Fix | Delete

$type = $this->core ? '_core' : '';

[136] Fix | Delete

[137] Fix | Delete

add_filter( "wpforms_form_templates{$type}", [ $this, 'template_details' ], $this->priority );

[138] Fix | Delete

add_filter( 'wpforms_create_form_args', [ $this, 'template_data' ], 10, 2 );

[139] Fix | Delete

add_filter( 'wpforms_save_form_args', [ $this, 'template_replace' ], 10, 3 );

[140] Fix | Delete

add_filter( 'wpforms_builder_template_active', [ $this, 'template_active' ], 10, 2 );

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Let's get started.

[145] Fix | Delete

*

[146] Fix | Delete

* @since 1.0.0

[147] Fix | Delete

*/

[148] Fix | Delete

public function init() {}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Add basic template details to the Add New Form admin screen.

[152] Fix | Delete

*

[153] Fix | Delete

* @since 1.0.0

[154] Fix | Delete

*

[155] Fix | Delete

* @param array $templates Templates array.

[156] Fix | Delete

*

[157] Fix | Delete

* @return array

[158] Fix | Delete

*/

[159] Fix | Delete

public function template_details( $templates ) {

[160] Fix | Delete

[161] Fix | Delete

$templates[] = [

[162] Fix | Delete

'name' => $this->name,

[163] Fix | Delete

'slug' => $this->slug,

[164] Fix | Delete

'source' => $this->source,

[165] Fix | Delete

'categories' => $this->categories,

[166] Fix | Delete

'description' => $this->description,

[167] Fix | Delete

'includes' => $this->includes,

[168] Fix | Delete

'icon' => $this->icon,

[169] Fix | Delete

'url' => ! empty( $this->url ) ? $this->url : '',

[170] Fix | Delete

'plugin_dir' => $this->get_plugin_dir(),

[171] Fix | Delete

'thumbnail' => ! empty( $this->thumbnail ) ? $this->thumbnail : '',

[172] Fix | Delete

];

[173] Fix | Delete

[174] Fix | Delete

return $templates;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Get the directory name of the plugin in which current template resides.

[179] Fix | Delete

*

[180] Fix | Delete

* @since 1.6.9

[181] Fix | Delete

*

[182] Fix | Delete

* @return string

[183] Fix | Delete

*/

[184] Fix | Delete

private function get_plugin_dir(): string {

[185] Fix | Delete

[186] Fix | Delete

$reflection = new ReflectionClass( $this );

[187] Fix | Delete

$template_file_path = wp_normalize_path( $reflection->getFileName() );

[188] Fix | Delete

[189] Fix | Delete

// Cutting out the WP_PLUGIN_DIR from the beginning of the template file path.

[190] Fix | Delete

$template_file_path = preg_replace( '{^' . wp_slash( wp_normalize_path( WP_PLUGIN_DIR ) ) . '}', '', $template_file_path );

[191] Fix | Delete

[192] Fix | Delete

$template_file_chunks = explode( '/', $template_file_path );

[193] Fix | Delete

[194] Fix | Delete

return $template_file_chunks[1];

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

/**

[198] Fix | Delete

* Add template data when form is created.

[199] Fix | Delete

*

[200] Fix | Delete

* @since 1.0.0

[201] Fix | Delete

*

[202] Fix | Delete

* @param array $args Create form arguments.

[203] Fix | Delete

* @param array $data Template data.

[204] Fix | Delete

*

[205] Fix | Delete

* @return array

[206] Fix | Delete

*/

[207] Fix | Delete

public function template_data( $args, $data ): array {

[208] Fix | Delete

[209] Fix | Delete

if ( empty( $data['template'] ) || $data['template'] !== $this->slug ) {

[210] Fix | Delete

return $args;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

// Enable Notifications by default.

[214] Fix | Delete

$this->data['settings']['notification_enable'] = $this->data['settings']['notification_enable'] ?? '1';

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Allow modifying form data when a template is applied to the new form.

[218] Fix | Delete

*

[219] Fix | Delete

* @since 1.9.0

[220] Fix | Delete

*

[221] Fix | Delete

* @param array $form_data New form data.

[222] Fix | Delete

*/

[223] Fix | Delete

$this->data = (array) apply_filters( 'wpforms_templates_class_base_template_modify_data', $this->data );

[224] Fix | Delete

[225] Fix | Delete

$args['post_content'] = wpforms_encode( $this->data );

[226] Fix | Delete

[227] Fix | Delete

return $args;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

/**

[231] Fix | Delete

* Replace template on post update if triggered.

[232] Fix | Delete

*

[233] Fix | Delete

* @since 1.0.0

[234] Fix | Delete

*

[235] Fix | Delete

* @param array $form Form post data.

[236] Fix | Delete

* @param array $data Form data.

[237] Fix | Delete

* @param array $args Update form arguments.

[238] Fix | Delete

*

[239] Fix | Delete

* @return array

[240] Fix | Delete

*/

[241] Fix | Delete

public function template_replace( $form, $data, $args ): array {

[242] Fix | Delete

[243] Fix | Delete

// We should proceed only if the template slug passed via $args['template'] is equal to the current template slug.

[244] Fix | Delete

// This will work only for offline templates: Blank Form, all the Addons Templates, and all the custom templates.

[245] Fix | Delete

// All the online (modern) templates use the hash as the identifier,

[246] Fix | Delete

// and they are handled by `\WPForms\Admin\Builder\Templates::apply_to_existing_form()`.

[247] Fix | Delete

if ( empty( $args['template'] ) || $args['template'] !== $this->slug ) {

[248] Fix | Delete

return $form;

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

$form_data = wpforms_decode( wp_unslash( $form['post_content'] ) );

[252] Fix | Delete

[253] Fix | Delete

// Something is wrong with the form data.

[254] Fix | Delete

if ( empty( $form_data ) ) {

[255] Fix | Delete

return $form;

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

// Compile the new form data preserving needed data from the existing form.

[259] Fix | Delete

$new = $this->data;

[260] Fix | Delete

$new['id'] = $form_data['id'] ?? 0;

[261] Fix | Delete

$new['settings'] = $form_data['settings'] ?? [];

[262] Fix | Delete

$new['payments'] = $form_data['payments'] ?? [];

[263] Fix | Delete

$new['meta'] = $form_data['meta'] ?? [];

[264] Fix | Delete

[265] Fix | Delete

$template_id = $this->data['meta']['template'] ?? '';

[266] Fix | Delete

[267] Fix | Delete

// Preserve template ID `wpforms-user-template-{$form_id}` when overwriting it with core template.

[268] Fix | Delete

if ( wpforms_is_form_template( $form['ID'] ) ) {

[269] Fix | Delete

$template_id = $form_data['meta']['template'] ?? '';

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

$new['meta']['template'] = $template_id;

[273] Fix | Delete

[274] Fix | Delete

/**

[275] Fix | Delete

* Allow modifying form data when a template is replaced.

[276] Fix | Delete

*

[277] Fix | Delete

* @since 1.7.9

[278] Fix | Delete

*

[279] Fix | Delete

* @param array $new Updated form data.

[280] Fix | Delete

* @param array $form_data Current form data.

[281] Fix | Delete

* @param array $template Template data.

[282] Fix | Delete

*/

[283] Fix | Delete

$new = (array) apply_filters( 'wpforms_templates_class_base_template_replace_modify_data', $new, $form_data, $this );

[284] Fix | Delete

[285] Fix | Delete

// Update the form with new data.

[286] Fix | Delete

$form['post_content'] = wpforms_encode( $new );

[287] Fix | Delete

[288] Fix | Delete

return $form;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Pass information about the active template back to the builder.

[293] Fix | Delete

*

[294] Fix | Delete

* @since 1.0.0

[295] Fix | Delete

*

[296] Fix | Delete

* @param array $details Details.

[297] Fix | Delete

* @param object $form Form data.

[298] Fix | Delete

*

[299] Fix | Delete

* @return array|void

[300] Fix | Delete

*/

[301] Fix | Delete

public function template_active( $details, $form ) {

[302] Fix | Delete

[303] Fix | Delete

if ( empty( $form ) ) {

[304] Fix | Delete

return;

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

$form_data = wpforms_decode( $form->post_content );

[308] Fix | Delete

[309] Fix | Delete

if ( empty( $this->modal ) || empty( $form_data['meta']['template'] ) || $this->slug !== $form_data['meta']['template'] ) {

[310] Fix | Delete

return $details;

[311] Fix | Delete

} else {

[312] Fix | Delete

$display = $this->template_modal_conditional( $form_data );

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

return [

[316] Fix | Delete

'name' => $this->name,

[317] Fix | Delete

'slug' => $this->slug,

[318] Fix | Delete

'description' => $this->description,

[319] Fix | Delete

'includes' => $this->includes,

[320] Fix | Delete

'icon' => $this->icon,

[321] Fix | Delete

'modal' => $this->modal,

[322] Fix | Delete

'modal_display' => $display,

[323] Fix | Delete

];

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

/**

[327] Fix | Delete

* Conditional to determine if the template informational modal screens

[328] Fix | Delete

* should display.

[329] Fix | Delete

*

[330] Fix | Delete

* @since 1.0.0

[331] Fix | Delete

*

[332] Fix | Delete

* @param array $form_data Form data and settings.

[333] Fix | Delete

*

[334] Fix | Delete

* @return bool

[335] Fix | Delete

*/

[336] Fix | Delete

public function template_modal_conditional( $form_data ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found

[337] Fix | Delete

[338] Fix | Delete

return false;

[339] Fix | Delete

}

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete