<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Forms;

[2] Fix | Delete

[3] Fix | Delete

use WP_Post;

[4] Fix | Delete

use WPForms\Admin\Notice;

[5] Fix | Delete

use WPForms\Pro\Tasks\Actions\PurgeTemplateEntryTask;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* User Templates class.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.8.8

[11] Fix | Delete

*/

[12] Fix | Delete

class UserTemplates {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Initialize class.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.8.8

[18] Fix | Delete

*/

[19] Fix | Delete

public function init() {

[20] Fix | Delete

[21] Fix | Delete

$this->hooks();

[22] Fix | Delete

}

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Hooks.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.8.8

[28] Fix | Delete

*/

[29] Fix | Delete

public function hooks() {

[30] Fix | Delete

[31] Fix | Delete

add_action( 'init', [ $this, 'register_post_type' ] );

[32] Fix | Delete

[33] Fix | Delete

// Add template states.

[34] Fix | Delete

add_filter( 'display_post_states', [ $this, 'add_template_states' ], 10, 2 );

[35] Fix | Delete

[36] Fix | Delete

// Modify get form args on the overview page.

[37] Fix | Delete

add_filter( 'wpforms_get_form_args', [ $this, 'add_template_post_type' ] );

[38] Fix | Delete

[39] Fix | Delete

// Modify Show Templates user option.

[40] Fix | Delete

add_filter( 'get_user_option_wpforms_forms_overview_show_form_templates', [ $this, 'get_forms_overview_show_form_templates_option' ] );

[41] Fix | Delete

[42] Fix | Delete

// Disable payment processing for user templates.

[43] Fix | Delete

add_filter( 'wpforms_process_before_form_data', [ $this, 'process_before_form_data' ] );

[44] Fix | Delete

[45] Fix | Delete

// Add user templates to the form templates list.

[46] Fix | Delete

add_filter( 'wpforms_form_templates', [ $this, 'add_form_templates' ] );

[47] Fix | Delete

[48] Fix | Delete

// AJAX handler for deleting user templates.

[49] Fix | Delete

add_action( 'wp_ajax_wpforms_user_template_remove', [ $this, 'ajax_remove_user_template' ] );

[50] Fix | Delete

[51] Fix | Delete

// Disable Lite Connect integration for user templates on form submission.

[52] Fix | Delete

add_action( 'wpforms_process', [ $this, 'process_entry' ], 10, 3 );

[53] Fix | Delete

[54] Fix | Delete

if ( wpforms()->is_pro() ) {

[55] Fix | Delete

// Add notices about entry(ies) being purged.

[56] Fix | Delete

add_action( 'admin_notices', [ $this, 'get_template_entries_notice' ] );

[57] Fix | Delete

add_action( 'admin_notices', [ $this, 'get_template_entry_notice' ] );

[58] Fix | Delete

[59] Fix | Delete

// Add purge entry task.

[60] Fix | Delete

add_filter( 'wpforms_tasks_get_tasks', [ $this, 'add_purge_entry_task' ] );

[61] Fix | Delete

[62] Fix | Delete

// Disable edit entry for templates.

[63] Fix | Delete

add_filter( 'wpforms_current_user_can', [ $this, 'disable_edit_entry' ], 10, 3 );

[64] Fix | Delete

}

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Register the `wpforms-template` post type.

[69] Fix | Delete

*

[70] Fix | Delete

* @since 1.8.8

[71] Fix | Delete

*/

[72] Fix | Delete

public function register_post_type() {

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Filter the arguments for the `wpforms-template` post type.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 1.8.8

[78] Fix | Delete

*

[79] Fix | Delete

* @param array $args Post type arguments.

[80] Fix | Delete

*/

[81] Fix | Delete

$args = apply_filters( // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[82] Fix | Delete

'wpforms_template_post_type_args',

[83] Fix | Delete

[

[84] Fix | Delete

'label' => 'WPForms Template',

[85] Fix | Delete

'public' => false,

[86] Fix | Delete

'exclude_from_search' => true,

[87] Fix | Delete

'show_ui' => false,

[88] Fix | Delete

'show_in_admin_bar' => false,

[89] Fix | Delete

'rewrite' => false,

[90] Fix | Delete

'query_var' => false,

[91] Fix | Delete

'can_export' => false,

[92] Fix | Delete

'supports' => [ 'title', 'author', 'revisions' ],

[93] Fix | Delete

'capability_type' => 'wpforms_form', // Not using 'capability_type' anywhere. It just has to be custom for security reasons.

[94] Fix | Delete

'map_meta_cap' => false, // Don't let WP to map meta caps to have a granular control over this process via 'map_meta_cap' filter.

[95] Fix | Delete

]

[96] Fix | Delete

);

[97] Fix | Delete

[98] Fix | Delete

register_post_type( 'wpforms-template', $args );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Add template states.

[103] Fix | Delete

*

[104] Fix | Delete

* @since 1.8.8

[105] Fix | Delete

*

[106] Fix | Delete

* @param array $post_states Array of post states.

[107] Fix | Delete

* @param WP_Post $post Post object.

[108] Fix | Delete

*

[109] Fix | Delete

* @return array

[110] Fix | Delete

*/

[111] Fix | Delete

public function add_template_states( $post_states, $post ) {

[112] Fix | Delete

[113] Fix | Delete

if ( ! ( wpforms_is_admin_page( 'overview' ) || wpforms_is_admin_page( 'entries' ) ) ) {

[114] Fix | Delete

return $post_states;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

// No need to show template states on the templates page.

[118] Fix | Delete

if ( wpforms_is_admin_page( 'overview' ) && wpforms()->obj( 'forms_views' )->get_current_view() === 'templates' ) {

[119] Fix | Delete

return $post_states;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

if ( $post->post_type === 'wpforms-template' ) {

[123] Fix | Delete

$post_states['wpforms_template'] = __( 'Template', 'wpforms-lite' );

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

return $post_states;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Disable edit entry for templates.

[131] Fix | Delete

*

[132] Fix | Delete

* @since 1.8.8

[133] Fix | Delete

*

[134] Fix | Delete

* @param bool $user_can Whether the current user can perform the given capability.

[135] Fix | Delete

* @param string $caps Capability name.

[136] Fix | Delete

* @param int $id The ID of the object to check against.

[137] Fix | Delete

*

[138] Fix | Delete

* @return bool Whether the current user can perform the given capability.

[139] Fix | Delete

*/

[140] Fix | Delete

public function disable_edit_entry( bool $user_can, $caps, $id ): bool {

[141] Fix | Delete

[142] Fix | Delete

if ( $caps === 'edit_entries_form_single' && wpforms_is_form_template( $id ) ) {

[143] Fix | Delete

$user_can = false;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

return $user_can;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Display admin notice for the entries page.

[151] Fix | Delete

*

[152] Fix | Delete

* @since 1.8.8

[153] Fix | Delete

*/

[154] Fix | Delete

public function get_template_entries_notice() {

[155] Fix | Delete

[156] Fix | Delete

if ( ! wpforms_is_admin_page( 'entries', 'list' ) ) {

[157] Fix | Delete

return;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[161] Fix | Delete

$form_id = ! empty( $_REQUEST['form_id'] ) ? absint( $_REQUEST['form_id'] ) : 0;

[162] Fix | Delete

[163] Fix | Delete

// The notice should be displayed only for form templates.

[164] Fix | Delete

if ( ! wpforms_is_form_template( $form_id ) ) {

[165] Fix | Delete

return;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

// If there are no entries, we don't need to display the notice on the empty state page.

[169] Fix | Delete

$entries = wpforms()->obj( 'entry' )->get_entries(

[170] Fix | Delete

[

[171] Fix | Delete

'form_id' => $form_id,

[172] Fix | Delete

'limit' => 1,

[173] Fix | Delete

]

[174] Fix | Delete

);

[175] Fix | Delete

[176] Fix | Delete

if ( empty( $entries ) ) {

[177] Fix | Delete

return;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/** This filter is documented in wpforms/src/Pro/Tasks/Actions/PurgeTemplateEntryTask.php */

[181] Fix | Delete

$delay = (int) apply_filters( 'wpforms_pro_tasks_actions_purge_template_entry_task_delay', DAY_IN_SECONDS ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[182] Fix | Delete

[183] Fix | Delete

Notice::warning(

[184] Fix | Delete

sprintf(

[185] Fix | Delete

/* translators: %s - delay in formatted time. */

[186] Fix | Delete

esc_html__( 'Form template entries are for testing purposes and will be automatically deleted after %s.', 'wpforms-lite' ),

[187] Fix | Delete

// The `- 1` hack is to avoid the "1 day" message in favor of "24 hours".

[188] Fix | Delete

human_time_diff( time(), time() + $delay - 1 )

[189] Fix | Delete

)

[190] Fix | Delete

);

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Display admin notice for the entry page.

[195] Fix | Delete

*

[196] Fix | Delete

* @since 1.8.8

[197] Fix | Delete

*/

[198] Fix | Delete

public function get_template_entry_notice() {

[199] Fix | Delete

[200] Fix | Delete

if ( ! wpforms_is_admin_page( 'entries', 'details' ) ) {

[201] Fix | Delete

return;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[205] Fix | Delete

$entry_id = ! empty( $_REQUEST['entry_id'] ) ? absint( $_REQUEST['entry_id'] ) : 0;

[206] Fix | Delete

[207] Fix | Delete

$entry = wpforms()->obj( 'entry' )->get( $entry_id );

[208] Fix | Delete

[209] Fix | Delete

// If entry does not exist, we don't need to display the notice on the empty state page.

[210] Fix | Delete

if ( empty( $entry ) ) {

[211] Fix | Delete

return;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

// The notice should be displayed only for form template entry.

[215] Fix | Delete

if ( ! wpforms_is_form_template( $entry->form_id ) ) {

[216] Fix | Delete

return;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

$meta = wpforms()->obj( 'entry_meta' )->get_meta(

[220] Fix | Delete

[

[221] Fix | Delete

'entry_id' => absint( $entry_id ),

[222] Fix | Delete

'type' => 'purge_template_entry_task',

[223] Fix | Delete

'number' => 1,

[224] Fix | Delete

]

[225] Fix | Delete

);

[226] Fix | Delete

[227] Fix | Delete

if ( empty( $meta ) ) {

[228] Fix | Delete

return;

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

$task = wpforms_json_decode( $meta[0]->data,true );

[232] Fix | Delete

[233] Fix | Delete

if ( empty( $task['timestamp'] ) ) {

[234] Fix | Delete

return;

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

Notice::warning(

[238] Fix | Delete

sprintf(

[239] Fix | Delete

/* translators: %s - delay in formatted time. */

[240] Fix | Delete

esc_html__( 'Form template entries are for testing purposes. This entry will be automatically deleted in %s.', 'wpforms-lite' ),

[241] Fix | Delete

human_time_diff( time(), $task['timestamp'] )

[242] Fix | Delete

)

[243] Fix | Delete

);

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Get the Show Templates user option.

[248] Fix | Delete

*

[249] Fix | Delete

* If the user has not set the Show Templates screen option, it will default to showing templates.

[250] Fix | Delete

* In this case, we want to show templates by default.

[251] Fix | Delete

*

[252] Fix | Delete

* @since 1.8.8

[253] Fix | Delete

*

[254] Fix | Delete

* @return bool Whether to show templates by default.

[255] Fix | Delete

*/

[256] Fix | Delete

public function get_forms_overview_show_form_templates_option(): bool {

[257] Fix | Delete

[258] Fix | Delete

$screen_options = get_user_option( 'wpforms_forms_overview_options' );

[259] Fix | Delete

[260] Fix | Delete

$result = $screen_options['wpforms_forms_overview_show_form_templates'] ?? true;

[261] Fix | Delete

[262] Fix | Delete

return $result !== '0'; // phpcs:ignore WPForms.Formatting.EmptyLineBeforeReturn.RemoveEmptyLineBeforeReturnStatement

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

/**

[266] Fix | Delete

* Add `wpforms-template` post type to the form args.

[267] Fix | Delete

*

[268] Fix | Delete

* @since 1.8.8

[269] Fix | Delete

*

[270] Fix | Delete

* @param array $args Form arguments.

[271] Fix | Delete

*

[272] Fix | Delete

* @return array

[273] Fix | Delete

*/

[274] Fix | Delete

public function add_template_post_type( array $args ): array {

[275] Fix | Delete

[276] Fix | Delete

// Only add the post type to the form args on the overview page.

[277] Fix | Delete

if ( ! wpforms_is_admin_page( 'overview' ) ) {

[278] Fix | Delete

return $args;

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

// Only add the template post type if the Show Templates screen option is enabled

[282] Fix | Delete

// and `post_type` is not already set.

[283] Fix | Delete

if ( ! isset( $args['post_type'] ) && wpforms()->obj( 'forms_overview' )->overview_show_form_templates() ) {

[284] Fix | Delete

$args['post_type'] = wpforms()->obj( 'form' )::POST_TYPES;

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

return $args;

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

/**

[291] Fix | Delete

* Add user templates to the form templates list.

[292] Fix | Delete

*

[293] Fix | Delete

* @since 1.8.8

[294] Fix | Delete

*

[295] Fix | Delete

* @param array $templates Form templates.

[296] Fix | Delete

*

[297] Fix | Delete

* @return array Form templates.

[298] Fix | Delete

*/

[299] Fix | Delete

public function add_form_templates( array $templates ): array {

[300] Fix | Delete

[301] Fix | Delete

$user_templates = wpforms()->obj( 'form' )->get( '', [ 'post_type' => 'wpforms-template' ] );

[302] Fix | Delete

[303] Fix | Delete

if ( empty( $user_templates ) ) {

[304] Fix | Delete

return $templates;

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

foreach ( $user_templates as $template ) {

[308] Fix | Delete

$template_data = wpforms_decode( $template->post_content );

[309] Fix | Delete

[310] Fix | Delete

$edit_url = add_query_arg(

[311] Fix | Delete

[

[312] Fix | Delete

'page' => 'wpforms-builder',

[313] Fix | Delete

'form_id' => $template->ID,

[314] Fix | Delete

],

[315] Fix | Delete

admin_url( 'admin.php' )

[316] Fix | Delete

);

[317] Fix | Delete

[318] Fix | Delete

$create_url = add_query_arg(

[319] Fix | Delete

[

[320] Fix | Delete

'page' => 'wpforms-builder',

[321] Fix | Delete

'form_id' => $template->ID,

[322] Fix | Delete

'action' => 'template_to_form',

[323] Fix | Delete

'_wpnonce' => wp_create_nonce( 'wpforms_template_to_form_form_nonce' ),

[324] Fix | Delete

],

[325] Fix | Delete

admin_url( 'admin.php' )

[326] Fix | Delete

);

[327] Fix | Delete

[328] Fix | Delete

$templates[] = [

[329] Fix | Delete

'name' => $template->post_title,

[330] Fix | Delete

'slug' => 'wpforms-user-template-' . $template->ID,

[331] Fix | Delete

'action_text' => wpforms_is_admin_page( 'builder' ) || wp_doing_ajax() ? esc_html__( 'Use Template', 'wpforms-lite' ) : esc_html__( 'Create Form', 'wpforms-lite' ),

[332] Fix | Delete

'edit_action_text' => esc_html__( 'Edit Template', 'wpforms-lite' ),

[333] Fix | Delete

'description' => ! empty( $template_data['settings']['template_description'] ) ? $template_data['settings']['template_description'] : '',

[334] Fix | Delete

'source' => 'wpforms-user-template',

[335] Fix | Delete

'create_url' => $create_url,

[336] Fix | Delete

'edit_url' => $edit_url,

[337] Fix | Delete

'categories' => [ 'user' ],

[338] Fix | Delete

'has_access' => true,

[339] Fix | Delete

'data' => $template_data,

[340] Fix | Delete

'post_id' => $template->ID,

[341] Fix | Delete

];

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

return $templates;

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

/**

[348] Fix | Delete

* AJAX handler for removing user templates.

[349] Fix | Delete

*

[350] Fix | Delete

* @since 1.8.8

[351] Fix | Delete

*/

[352] Fix | Delete

public function ajax_remove_user_template(): void {

[353] Fix | Delete

[354] Fix | Delete

// Run a security check.

[355] Fix | Delete

check_ajax_referer( 'wpforms-form-templates', 'nonce' );

[356] Fix | Delete

[357] Fix | Delete

$template_id = isset( $_POST['template'] ) ? absint( $_POST['template'] ) : 0;

[358] Fix | Delete

[359] Fix | Delete

if ( ! $template_id ) {

[360] Fix | Delete

wp_send_json_error();

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

// Check for permissions for the specific template.

[364] Fix | Delete

if ( ! wpforms_current_user_can( 'delete_form_single', $template_id ) ) {

[365] Fix | Delete

wp_send_json_error( esc_html__( 'You do not have permission to delete this template.', 'wpforms-lite' ) );

[366] Fix | Delete

}

[367] Fix | Delete

[368] Fix | Delete

// Verify the post exists and is a template.

[369] Fix | Delete

$template = get_post( $template_id );

[370] Fix | Delete

[371] Fix | Delete

if ( ! $template || $template->post_type !== 'wpforms-template' ) {

[372] Fix | Delete

wp_send_json_error( esc_html__( 'Template not found.', 'wpforms-lite' ) );

[373] Fix | Delete

}

[374] Fix | Delete

[375] Fix | Delete

// Delete the template.

[376] Fix | Delete

$result = wp_delete_post( $template_id, true );

[377] Fix | Delete

[378] Fix | Delete

if ( ! $result ) {

[379] Fix | Delete

wp_send_json_error( esc_html__( 'Failed to delete the template.', 'wpforms-lite' ) );

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

wp_send_json_success();

[383] Fix | Delete

}

[384] Fix | Delete

[385] Fix | Delete

/**

[386] Fix | Delete

* Add purge entry task.

[387] Fix | Delete

*

[388] Fix | Delete

* @since 1.8.8

[389] Fix | Delete

*

[390] Fix | Delete

* @param array $tasks Task class list.

[391] Fix | Delete

*/

[392] Fix | Delete

public function add_purge_entry_task( $tasks ) {

[393] Fix | Delete

[394] Fix | Delete

$tasks[] = PurgeTemplateEntryTask::class;

[395] Fix | Delete

[396] Fix | Delete

return $tasks;

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete

/**

[400] Fix | Delete

* Modify the form data before it is processed to disable payment processing.

[401] Fix | Delete

*

[402] Fix | Delete

* @since 1.8.8

[403] Fix | Delete

*

[404] Fix | Delete

* @param array $form_data Form data.

[405] Fix | Delete

*

[406] Fix | Delete

* @return array

[407] Fix | Delete

*/

[408] Fix | Delete

public function process_before_form_data( $form_data ) {

[409] Fix | Delete

[410] Fix | Delete

if ( ! isset( $form_data['id'] ) ) {

[411] Fix | Delete

return $form_data;

[412] Fix | Delete

}

[413] Fix | Delete

[414] Fix | Delete

if ( wpforms_is_form_template( $form_data['id'] ) ) {

[415] Fix | Delete

$form_data['payments'] = [];

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

return $form_data;

[419] Fix | Delete

}

[420] Fix | Delete

[421] Fix | Delete

/**

[422] Fix | Delete

* Disable Lite Connect integration for user templates while processing submission.

[423] Fix | Delete

*

[424] Fix | Delete

* @since 1.8.8

[425] Fix | Delete

*

[426] Fix | Delete

* @param array $fields Form fields.

[427] Fix | Delete

* @param array $entry Form entry.

[428] Fix | Delete

* @param array $form_data Form data.

[429] Fix | Delete

*/

[430] Fix | Delete

public function process_entry( array $fields, array $entry, array $form_data ) { // phpcs:ignore WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks

[431] Fix | Delete

[432] Fix | Delete

if ( ! wpforms_is_form_template( $form_data['id'] ) ) {

[433] Fix | Delete

return;

[434] Fix | Delete

}

[435] Fix | Delete

[436] Fix | Delete

add_filter( 'wpforms_integrations_lite_connect_is_allowed', '__return_false' );

[437] Fix | Delete

}

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete