Edit File by line

/**

[500] Fix | Delete

* Convert text formatted HTML. This is primarily for turning line breaks

[501] Fix | Delete

* into <p> and <br/> tags.

[502] Fix | Delete

[503] Fix | Delete

* @since 1.1.3

[504] Fix | Delete

[505] Fix | Delete

* @param string $message Text to convert.

[506] Fix | Delete

[507] Fix | Delete

* @return string

[508] Fix | Delete

[509] Fix | Delete

public function text_to_html( $message ) {

[510] Fix | Delete

[511] Fix | Delete

if ( 'text/html' === $this->content_type || true === $this->html ) {

[512] Fix | Delete

$message = wpautop( $message );

[513] Fix | Delete

}

[514] Fix | Delete

[515] Fix | Delete

return $message;

[516] Fix | Delete

}

[517] Fix | Delete

[518] Fix | Delete

/**

[519] Fix | Delete

* Process a smart tag.

[520] Fix | Delete

* Decodes entities and sanitized (keeping line breaks) by default.

[521] Fix | Delete

[522] Fix | Delete

* @uses wpforms_decode_string()

[523] Fix | Delete

[524] Fix | Delete

* @since 1.1.3

[525] Fix | Delete

* @since 1.6.0 Deprecated 2 params: $sanitize, $linebreaks.

[526] Fix | Delete

[527] Fix | Delete

* @param string $string String that may contain tags.

[528] Fix | Delete

[529] Fix | Delete

* @return string

[530] Fix | Delete

[531] Fix | Delete

public function process_tag( $string = '' ) {

[532] Fix | Delete

[533] Fix | Delete

return wpforms_process_smart_tags( $string, $this->form_data, $this->fields, $this->entry_id, 'email' );

[534] Fix | Delete

}

[535] Fix | Delete

[536] Fix | Delete

/**

[537] Fix | Delete

* Process the all fields smart tag if present.

[538] Fix | Delete

[539] Fix | Delete

* @since 1.1.3

[540] Fix | Delete

[541] Fix | Delete

* @param bool $is_html_email Toggle to use HTML or plaintext.

[542] Fix | Delete

[543] Fix | Delete

* @return string

[544] Fix | Delete

[545] Fix | Delete

public function wpforms_html_field_value( $is_html_email = true ) { // phpcs:ignore

[546] Fix | Delete

[547] Fix | Delete

if ( empty( $this->fields ) ) {

[548] Fix | Delete

return '';

[549] Fix | Delete

}

[550] Fix | Delete

[551] Fix | Delete

if ( empty( $this->form_data['fields'] ) ) {

[552] Fix | Delete

$is_html_email = false;

[553] Fix | Delete

}

[554] Fix | Delete

[555] Fix | Delete

$message = '';

[556] Fix | Delete

[557] Fix | Delete

if ( $is_html_email ) {

[558] Fix | Delete

[559] Fix | Delete

* HTML emails.

[560] Fix | Delete

[561] Fix | Delete

ob_start();

[562] Fix | Delete

[563] Fix | Delete

// Hooks into the email field.

[564] Fix | Delete

do_action( 'wpforms_email_field', $this );

[565] Fix | Delete

[566] Fix | Delete

$this->get_template_part( 'field', $this->get_template(), true );

[567] Fix | Delete

[568] Fix | Delete

$field_template = ob_get_clean();

[569] Fix | Delete

[570] Fix | Delete

// Check to see if user has added support for field type.

[571] Fix | Delete

$other_fields = apply_filters( 'wpforms_email_display_other_fields', [], $this );

[572] Fix | Delete

[573] Fix | Delete

$x = 1;

[574] Fix | Delete

[575] Fix | Delete

foreach ( $this->form_data['fields'] as $field_id => $field ) {

[576] Fix | Delete

[577] Fix | Delete

$field_name = '';

[578] Fix | Delete

$field_val = '';

[579] Fix | Delete

[580] Fix | Delete

// If the field exists in the form_data but not in the final

[581] Fix | Delete

// field data, then it's a non-input based field, "other fields".

[582] Fix | Delete

if ( empty( $this->fields[ $field_id ] ) ) {

[583] Fix | Delete

[584] Fix | Delete

if ( empty( $other_fields ) || ! in_array( $field['type'], $other_fields, true ) ) {

[585] Fix | Delete

continue;

[586] Fix | Delete

}

[587] Fix | Delete

[588] Fix | Delete

if ( $field['type'] === 'divider' ) {

[589] Fix | Delete

$field_name = ! empty( $field['label'] ) ? str_repeat( '—', 3 ) . ' ' . $field['label'] . ' ' . str_repeat( '—', 3 ) : null;

[590] Fix | Delete

$field_val = ! empty( $field['description'] ) ? $field['description'] : '';

[591] Fix | Delete

} elseif ( $field['type'] === 'pagebreak' ) {

[592] Fix | Delete

if ( ! empty( $field['position'] ) && $field['position'] === 'bottom' ) {

[593] Fix | Delete

continue;

[594] Fix | Delete

}

[595] Fix | Delete

$title = ! empty( $field['title'] ) ? $field['title'] : esc_html__( 'Page Break', 'wpforms-lite' );

[596] Fix | Delete

$field_name = str_repeat( '—', 6 ) . ' ' . $title . ' ' . str_repeat( '—', 6 );

[597] Fix | Delete

} elseif ( $field['type'] === 'html' ) {

[598] Fix | Delete

[599] Fix | Delete

if ( $this->is_field_conditionally_hidden( $field['id'] ) ) {

[600] Fix | Delete

continue;

[601] Fix | Delete

}

[602] Fix | Delete

[603] Fix | Delete

$field_name = ! empty( $field['name'] ) ? $field['name'] : esc_html__( 'HTML / Code Block', 'wpforms-lite' );

[604] Fix | Delete

$field_val = $field['code'];

[605] Fix | Delete

} elseif ( $field['type'] === 'content' ) {

[606] Fix | Delete

[607] Fix | Delete

if ( $this->is_field_conditionally_hidden( $field['id'] ) ) {

[608] Fix | Delete

continue;

[609] Fix | Delete

}

[610] Fix | Delete

[611] Fix | Delete

$field_name = esc_html__( 'Content', 'wpforms-lite' );

[612] Fix | Delete

$field_val = $field['content'];

[613] Fix | Delete

}

[614] Fix | Delete

} else {

[615] Fix | Delete

[616] Fix | Delete

if (

[617] Fix | Delete

! apply_filters( 'wpforms_email_display_empty_fields', false ) &&

[618] Fix | Delete

( ! isset( $this->fields[ $field_id ]['value'] ) || (string) $this->fields[ $field_id ]['value'] === '' )

[619] Fix | Delete

) {

[620] Fix | Delete

continue;

[621] Fix | Delete

}

[622] Fix | Delete

[623] Fix | Delete

if ( $field['type'] === 'payment-total' ) {

[624] Fix | Delete

[625] Fix | Delete

$field_name = isset( $this->fields[ $field_id ]['name'] ) ? $this->fields[ $field_id ]['name'] : '';

[626] Fix | Delete

[627] Fix | Delete

// Replace the payment total value if an order summary is enabled.

[628] Fix | Delete

// Ideally, it could be done through the `wpforms_html_field_value` filter,

[629] Fix | Delete

// but needed data is missed there, e.g. entry data ($this->fields).

[630] Fix | Delete

if ( ! empty( $field['summary'] ) ) {

[631] Fix | Delete

$field_val = $this->process_tag( '{order_summary}' );

[632] Fix | Delete

} else {

[633] Fix | Delete

$field_val = $this->fields[ $field_id ]['value'];

[634] Fix | Delete

}

[635] Fix | Delete

} else {

[636] Fix | Delete

$field_name = isset( $this->fields[ $field_id ]['name'] ) ? $this->fields[ $field_id ]['name'] : '';

[637] Fix | Delete

$field_val = empty( $this->fields[ $field_id ]['value'] ) && ! is_numeric( $this->fields[ $field_id ]['value'] ) ? '<em>' . esc_html__( '(empty)', 'wpforms-lite' ) . '</em>' : $this->fields[ $field_id ]['value'];

[638] Fix | Delete

}

[639] Fix | Delete

}

[640] Fix | Delete

[641] Fix | Delete

if ( empty( $field_name ) && null !== $field_name ) {

[642] Fix | Delete

$field_name = sprintf( /* translators: %d - field ID. */

[643] Fix | Delete

esc_html__( 'Field ID #%s', 'wpforms-lite' ),

[644] Fix | Delete

wpforms_validate_field_id( $field['id'] )

[645] Fix | Delete

);

[646] Fix | Delete

}

[647] Fix | Delete

[648] Fix | Delete

$field_item = $field_template;

[649] Fix | Delete

[650] Fix | Delete

if ( 1 === $x ) {

[651] Fix | Delete

$field_item = str_replace( 'border-top:1px solid #dddddd;', '', $field_item );

[652] Fix | Delete

}

[653] Fix | Delete

$field_item = str_replace( '{field_name}', $field_name, $field_item );

[654] Fix | Delete

$field_item = str_replace(

[655] Fix | Delete

'{field_value}',

[656] Fix | Delete

apply_filters(

[657] Fix | Delete

'wpforms_html_field_value',

[658] Fix | Delete

$field_val,

[659] Fix | Delete

isset( $this->fields[ $field_id ] ) ? $this->fields[ $field_id ] : $field,

[660] Fix | Delete

$this->form_data,

[661] Fix | Delete

'email-html'

[662] Fix | Delete

[663] Fix | Delete

$field_item

[664] Fix | Delete

);

[665] Fix | Delete

[666] Fix | Delete

$message .= wpautop( $field_item );

[667] Fix | Delete

[668] Fix | Delete

$x ++;

[669] Fix | Delete

}

[670] Fix | Delete

} else {

[671] Fix | Delete

[672] Fix | Delete

* Plain Text emails.

[673] Fix | Delete

[674] Fix | Delete

foreach ( $this->fields as $field ) {

[675] Fix | Delete

[676] Fix | Delete

if (

[677] Fix | Delete

! apply_filters( 'wpforms_email_display_empty_fields', false ) &&

[678] Fix | Delete

( ! isset( $field['value'] ) || (string) $field['value'] === '' )

[679] Fix | Delete

) {

[680] Fix | Delete

continue;

[681] Fix | Delete

}

[682] Fix | Delete

[683] Fix | Delete

$field_val = empty( $field['value'] ) && ! is_numeric( $field['value'] ) ? esc_html__( '(empty)', 'wpforms-lite' ) : $field['value'];

[684] Fix | Delete

$field_name = $field['name'];

[685] Fix | Delete

[686] Fix | Delete

if ( empty( $field_name ) ) {

[687] Fix | Delete

$field_name = sprintf( /* translators: %d - field ID. */

[688] Fix | Delete

esc_html__( 'Field ID #%s', 'wpforms-lite' ),

[689] Fix | Delete

wpforms_validate_field_id( $field['id'] )

[690] Fix | Delete

);

[691] Fix | Delete

}

[692] Fix | Delete

[693] Fix | Delete

$message .= '--- ' . $field_name . " ---\r\n\r\n";

[694] Fix | Delete

$field_value = $field_val . "\r\n\r\n";

[695] Fix | Delete

$message .= apply_filters( 'wpforms_plaintext_field_value', $field_value, $field, $this->form_data );

[696] Fix | Delete

}

[697] Fix | Delete

}

[698] Fix | Delete

[699] Fix | Delete

if ( empty( $message ) ) {

[700] Fix | Delete

$empty_message = esc_html__( 'An empty form was submitted.', 'wpforms-lite' );

[701] Fix | Delete

$message = $is_html_email ? wpautop( $empty_message ) : $empty_message;

[702] Fix | Delete

}

[703] Fix | Delete

[704] Fix | Delete

return $message;

[705] Fix | Delete

}

[706] Fix | Delete

[707] Fix | Delete

/**

[708] Fix | Delete

* Email kill switch if needed.

[709] Fix | Delete

[710] Fix | Delete

* @since 1.1.3

[711] Fix | Delete

[712] Fix | Delete

* @return bool

[713] Fix | Delete

[714] Fix | Delete

public function is_email_disabled() {

[715] Fix | Delete

[716] Fix | Delete

return (bool) apply_filters( 'wpforms_disable_all_emails', false, $this );

[717] Fix | Delete

}

[718] Fix | Delete

[719] Fix | Delete

/**

[720] Fix | Delete

* Get the enabled email template.

[721] Fix | Delete

[722] Fix | Delete

* @since 1.1.3

[723] Fix | Delete

[724] Fix | Delete

* @return string When filtering return 'none' to switch to text/plain email.

[725] Fix | Delete

[726] Fix | Delete

public function get_template() {

[727] Fix | Delete

[728] Fix | Delete

if ( ! $this->template ) {

[729] Fix | Delete

$this->template = wpforms_setting( 'email-template', 'default' );

[730] Fix | Delete

}

[731] Fix | Delete

[732] Fix | Delete

return apply_filters( 'wpforms_email_template', $this->template );

[733] Fix | Delete

}

[734] Fix | Delete

[735] Fix | Delete

/**

[736] Fix | Delete

* Retrieve a template part. Taken from bbPress.

[737] Fix | Delete

[738] Fix | Delete

* @since 1.1.3

[739] Fix | Delete

[740] Fix | Delete

* @param string $slug Template file slug.

[741] Fix | Delete

* @param string $name Optional. Default null.

[742] Fix | Delete

* @param bool $load Maybe load.

[743] Fix | Delete

[744] Fix | Delete

* @return string

[745] Fix | Delete

[746] Fix | Delete

public function get_template_part( $slug, $name = null, $load = true ) {

[747] Fix | Delete

[748] Fix | Delete

// Setup possible parts.

[749] Fix | Delete

$templates = [];

[750] Fix | Delete

[751] Fix | Delete

if ( isset( $name ) ) {

[752] Fix | Delete

$templates[] = $slug . '-' . $name . '.php';

[753] Fix | Delete

}

[754] Fix | Delete

[755] Fix | Delete

$templates[] = $slug . '.php';

[756] Fix | Delete

[757] Fix | Delete

// Return the part that is found.

[758] Fix | Delete

return $this->locate_template( $templates, $load, false );

[759] Fix | Delete

}

[760] Fix | Delete

[761] Fix | Delete

/**

[762] Fix | Delete

* Retrieve the name of the highest priority template file that exists.

[763] Fix | Delete

[764] Fix | Delete

* Search in the STYLESHEETPATH before TEMPLATEPATH so that themes which

[765] Fix | Delete

* inherit from a parent theme can just overload one file. If the template is

[766] Fix | Delete

* not found in either of those, it looks in the theme-compat folder last.

[767] Fix | Delete

[768] Fix | Delete

* Taken from bbPress.

[769] Fix | Delete

[770] Fix | Delete

* @since 1.1.3

[771] Fix | Delete

[772] Fix | Delete

* @param string|array $template_names Template file(s) to search for, in order.

[773] Fix | Delete

* @param bool $load If true the template file will be loaded if it is found.

[774] Fix | Delete

* @param bool $require_once Whether to require_once or require. Default true.

[775] Fix | Delete

* Has no effect if $load is false.

[776] Fix | Delete

[777] Fix | Delete

* @return string The template filename if one is located.

[778] Fix | Delete

[779] Fix | Delete

public function locate_template( $template_names, $load = false, $require_once = true ) {

[780] Fix | Delete

[781] Fix | Delete

// No file found yet.

[782] Fix | Delete

$located = false;

[783] Fix | Delete

[784] Fix | Delete

// Try to find a template file.

[785] Fix | Delete

foreach ( (array) $template_names as $template_name ) {

[786] Fix | Delete

[787] Fix | Delete

// Continue if template is empty.

[788] Fix | Delete

if ( empty( $template_name ) ) {

[789] Fix | Delete

continue;

[790] Fix | Delete

}

[791] Fix | Delete

[792] Fix | Delete

// Trim off any slashes from the template name.

[793] Fix | Delete

$template_name = ltrim( $template_name, '/' );

[794] Fix | Delete

[795] Fix | Delete

// Try locating this template file by looping through the template paths.

[796] Fix | Delete

foreach ( $this->get_theme_template_paths() as $template_path ) {

[797] Fix | Delete

$validated_path = Templates::validate_safe_path(

[798] Fix | Delete

$template_path . $template_name,

[799] Fix | Delete

[ 'theme', 'plugins' ]

[800] Fix | Delete

);

[801] Fix | Delete

[802] Fix | Delete

if ( $validated_path ) {

[803] Fix | Delete

$located = $validated_path;

[804] Fix | Delete

[805] Fix | Delete

break;

[806] Fix | Delete

}

[807] Fix | Delete

}

[808] Fix | Delete

}

[809] Fix | Delete

[810] Fix | Delete

if ( ( true === $load ) && ! empty( $located ) ) {

[811] Fix | Delete

load_template( $located, $require_once );

[812] Fix | Delete

}

[813] Fix | Delete

[814] Fix | Delete

return $located;

[815] Fix | Delete

}

[816] Fix | Delete

[817] Fix | Delete

/**

[818] Fix | Delete

* Return a list of paths to check for template locations

[819] Fix | Delete

[820] Fix | Delete

* @since 1.1.3

[821] Fix | Delete

[822] Fix | Delete

* @return array

[823] Fix | Delete

[824] Fix | Delete

public function get_theme_template_paths() {

[825] Fix | Delete

[826] Fix | Delete

$template_dir = 'wpforms-email';

[827] Fix | Delete

[828] Fix | Delete

$file_paths = [

[829] Fix | Delete

1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,

[830] Fix | Delete

10 => trailingslashit( get_template_directory() ) . $template_dir,

[831] Fix | Delete

100 => WPFORMS_PLUGIN_DIR . 'includes/emails/templates',

[832] Fix | Delete

];

[833] Fix | Delete

[834] Fix | Delete

$file_paths = apply_filters( 'wpforms_email_template_paths', $file_paths );

[835] Fix | Delete

[836] Fix | Delete

// Sort the file paths based on priority.

[837] Fix | Delete

ksort( $file_paths, SORT_NUMERIC );

[838] Fix | Delete

[839] Fix | Delete

return array_map( 'trailingslashit', $file_paths );

[840] Fix | Delete

}

[841] Fix | Delete

[842] Fix | Delete

/**

[843] Fix | Delete

* Perform email subject preparation: process tags, remove new lines, etc.

[844] Fix | Delete

[845] Fix | Delete

* @since 1.6.1

[846] Fix | Delete

[847] Fix | Delete

* @param string $subject Email subject to post-process.

[848] Fix | Delete

[849] Fix | Delete

* @return string

[850] Fix | Delete

[851] Fix | Delete

private function get_prepared_subject( $subject ) {

[852] Fix | Delete

[853] Fix | Delete

$subject = $this->process_tag( $subject );

[854] Fix | Delete

[855] Fix | Delete

$subject = trim( str_replace( [ "\r\n", "\r", "\n" ], ' ', $subject ) );

[856] Fix | Delete

[857] Fix | Delete

return wpforms_decode_string( $subject );

[858] Fix | Delete

}

[859] Fix | Delete

[860] Fix | Delete

/**

[861] Fix | Delete

* If CL is enabled and the field is conditionally hidden, hide it from message.

[862] Fix | Delete

[863] Fix | Delete

* @since 1.7.9

[864] Fix | Delete

[865] Fix | Delete

* @param int $field_id Field ID.

[866] Fix | Delete

[867] Fix | Delete

* @return bool

[868] Fix | Delete

[869] Fix | Delete

private function is_field_conditionally_hidden( $field_id ) {

[870] Fix | Delete

[871] Fix | Delete

return ! empty( $this->form_data['fields'][ $field_id ]['conditionals'] ) && ! wpforms_conditional_logic_fields()->field_is_visible( $this->form_data, $field_id );

[872] Fix | Delete

}

[873] Fix | Delete

}

[874] Fix | Delete

[875] Fix | Delete