[Resolved] Technical issue / Bug in the WPML WPForms Multilingual plugin

Bug free WPForms Multilingual code for Notifications.php:

<?php

namespace WPML\Forms\Hooks\WpForms;

use WPForms_Conditional_Logic_Fields;
use WPML\Forms\Helpers\WpForms\Field;
use WPML\Forms\Hooks\Base;
use WPML\Forms\WpForms\SmartTag;
use WPML\FP\Fns;
use WPML\FP\Obj;
use WPML\FP\Lst;
use function WPML\FP\pipe;

class Notifications extends Base {

const EMAIL_HTML_CONTEXT = 'email-html';

/** Adds hooks. */
public function addHooks() {
add_filter( 'wpforms_process_before_form_data', [ $this, 'applyConfirmationTranslations' ] );
add_filter( 'wpforms_emails_send_email_data', [ $this, 'applyEmailTranslations' ], 10, 2 );
add_action( 'wpforms_email_send_after', [ $this, 'restoreLanguage' ] );
add_filter( 'wpml_user_language', [ $this, 'getLanguageForEmail' ], 10, 2 );
add_filter( 'wpforms_entry_email_data', [ $this, 'restoreFieldLabelsToDefaultLanguage' ], 10, 3 );

add_filter( 'wpforms_html_field_value', [ $this, 'restoreRawValuesForHtmlEmail' ], 10, 4 );
add_filter( 'wpforms_plaintext_field_value', [ $this, 'restoreRawValuesForNotifications' ], 10, 2 );

// These are only required in the 'Pro' version.
if (
class_exists( WPForms_Conditional_Logic_Fields::class )
&& has_filter( 'wpforms_entry_email_process', [ WPForms_Conditional_Logic_Fields::instance(), 'process_notification_conditionals' ] )
) {
remove_filter( 'wpforms_entry_email_process', [ WPForms_Conditional_Logic_Fields::instance(), 'process_notification_conditionals' ], 10 );
add_filter( 'wpforms_entry_email_process', [ $this, 'processNotificationConditionals' ], 10, 4 );
}
}

/**
* @param string $value
* @param array $field
* @param array $formData
* @param string $context
*
* @return string
*/
public function restoreRawValuesForHtmlEmail( string $value, array $field, array $formData, string $context ) : string {
if ( self::EMAIL_HTML_CONTEXT === $context ) {
return $this->restoreRawValuesForNotifications( $value, $field );
}

return $value;
}

/**
* @param string $value
* @param array $field
*
* @return string
*/
public function restoreRawValuesForNotifications( string $value, array $field ) : string {
if (
in_array( $field['type'], [ 'radio', 'select', 'checkbox' ], true )
&& ! Field::isDynamic( $field )
) {
return Obj::propOr( $value, 'value_raw', $field );
}

return $value;
}

/**
* Restores field labels to default language.
*
* Clone-aware and null-safe for repeater keys like "43_2".
*
* @param array $fields The form fields.
* @param array $entry The form entry.
* @param array $formData The form data.
*
* @return array
*/
public function restoreFieldLabelsToDefaultLanguage( $fields, $entry, $formData ) {

$formPost = wpforms()->get( 'form' )->get(
$formData['id'],
[ 'content_only' => true ]
);

$formPostFields = $formPost['fields'] ?? [];
$translatedFields = $formData['fields'] ?? [];
$entryFields = is_array( $entry ) ? ( $entry['fields'] ?? [] ) : [];

foreach ( $fields as $key => &$field ) {

// Resolve structures using a clone-aware helper.
$formPostField = $this->getFieldByCloneAwareKey( $formPostFields, $key ) ?: [];
$translatedField = $this->getFieldByCloneAwareKey( $translatedFields, $key ) ?: [];
$entryField = $this->getFieldByCloneAwareKey( $entryFields, $key );

// Label: prefer original form-post label when available.
if ( is_array( $formPostField ) && isset( $formPostField['label'] ) ) {
$field['name'] = $formPostField['label'];
}

// Value: only translate/format when we have a submitted entry field structure.
if ( null !== $entryField && is_array( $entryField ) ) {
$field['value'] = $this->getFieldValue(
$field,
$entryField,
$formPostField,
$translatedField
);
}
}

return $fields;
}

/**
* Applies translations to email data.
*
* @param array $data Email data.
* @param \WPForms_WP_Emails $emails WPForms email object.
*
* @return mixed
*/
public function applyEmailTranslations( $data, $emails ) {
$package = $this->newPackage( $this->getId( $emails->form_data ) );

$email = is_array( $data['to'] ) ? reset( $data['to'] ) : $data['to'];
do_action( 'wpml_switch_language_for_email', $email );

$dataKeys = [ 'subject', 'message' ];
$formPost = wpforms()->get( 'form' )->get(
$emails->form_data['id'],
[ 'content_only' => true ]
);

if ( $this->notEmpty( 'settings', $formPost ) ) {

$formPost['settings'] = $package->translateFormSettings( $formPost['settings'] );
}

$current_notification = $formPost['settings']['notifications'][ $emails->notification_id ];

$setData = function( $data, $key ) use ( $current_notification ) {
if ( ! empty( $current_notification[ $key ] ) ) {
$data[ $key ] = $current_notification[ $key ];
}

return $data;
};

foreach ( $dataKeys as $key ) {
$data = $setData( $data, $key );
}

$data = SmartTag::process( $data, $formPost, $dataKeys );

$translated = [ 'notifications' => [ $emails->notification_id => $data ] ];
foreach ( $emails->fields as &$field ) {
$field['name'] = $package->translateString( $field['name'], strval( $this->getId( $field ) ), 'label' );
}

return $translated['notifications'][ $emails->notification_id ];
}

/**
* Restores current language.
*
* @codeCoverageIgnore
*/
public function restoreLanguage() {
do_action( 'wpml_restore_language_from_email' );
}

/**
* Applies form confirmations translations.
*
* @param array $formData Form data.
*
* @return array
*/
public function applyConfirmationTranslations( $formData ) {

$package = $this->newPackage( $this->getId( $formData ) );

if (
$this->notEmpty( 'settings', $formData )
&& $this->notEmpty( 'confirmations', $formData['settings'] )
) {
$formData['settings'] = $package->translateFormSettings( $formData['settings'] );

foreach ( $formData['settings']['confirmations'] as &$confirmation ) {

$confirmation = SmartTag::process( $confirmation, $formData );
}
}

return $formData;
}

/**
* Returns language to use for translation based on email.
* Will use the language of the post if non site user.
*
* @param string $language Language detected.
* @param string $email The user email.
*
* @return string
*/
public function getLanguageForEmail( $language, $email ) {
$user = get_user_by( 'email', $email );
if ( isset( $user->ID ) ) {
return $language;
}
return $this->getCurrentFormLanguage();
}

/**
* @return string
*/
private function getCurrentFormLanguage() {
return apply_filters( 'wpml_current_language', '' );
}

/**
* Resolve a field by key, accepting clone keys like "43_2".
* Falls back to base "43" if the suffixed key is not present.
*
* @param array $array
* @param string|int $key
* @return mixed|null
*/
private function getFieldByCloneAwareKey( array $array, $key ) {
if ( array_key_exists( $key, $array ) ) {
return $array[ $key ];
}
if ( is_string( $key ) && preg_match( '/^(\d+)_\d+$/', $key, $m ) ) {
$base = $m[1];
if ( array_key_exists( $base, $array ) ) {
return $array[ $base ];
}
}
return null;
}

/**
* @param array $field Field in default language.
* @param array|string $entryField
* @param array $originalField
* @param array $translatedField
* @return string
*/
private function getFieldValue( $field, $entryField, $originalField, $translatedField ) {
$getField = Obj::path( Fns::__, $field );
$getOriginalField = Obj::path( Fns::__, $originalField );

switch ( $field['type'] ) {
case 'select':
case 'radio':
case 'checkbox':
$choicesMap = $this->getChoiceMap( $originalField, $translatedField );

if ( is_array( $entryField ) && $choicesMap ) {
$value = '';
foreach ( $entryField as $key => $val ) {
$value .= PHP_EOL . Obj::propOr( $entryField[ $key ], $val, $choicesMap );
}
return $value;
}
return Obj::propOr( $field['value'], $field['value'], $choicesMap );

case 'likert_scale':
$value = '';
if ( isset( $field['value_raw'] ) && is_array( $field['value_raw'] ) ) {
foreach ( $field['value_raw'] as $key => $val ) {
$value .= PHP_EOL . $getOriginalField( [ 'rows', $key ] ) . ':' . PHP_EOL
. $getOriginalField( [ 'columns', $val ] );
}
}
return $value;

case 'payment-multiple':
case 'payment-select':
return $getOriginalField( [ 'choices', $field['value_raw'], 'label' ] )
. ' - ' . $getField( [ 'currency' ] )
. ' ' . $getField( [ 'amount' ] );

case 'payment-checkbox':
$value = '';
$choiceIds = explode( ',', (string) $field['value_raw'] );
foreach ( $choiceIds as $key ) {
$value .= PHP_EOL . $getOriginalField( [ 'choices', $key, 'label' ] )
. ' - ' . $getField( [ 'currency' ] )
. ' ' . $getOriginalField( [ 'choices', $key, 'value' ] );
}
return $value;

default:
return $field['value'];
}
}

/**
* @param array $originalField
* @param array $translatedField
*
* @return array
*/
private function getChoiceMap( $originalField, $translatedField ) {
if ( ! is_array( $originalField ) || ! is_array( $translatedField ) ) {
return [];
}

if ( Obj::prop( 'dynamic_choices', $originalField ) ) {
return [];
}

$getChoices = pipe( Obj::path( [ 'choices' ] ), Lst::pluck( 'label' ) );

$originalChoices = $getChoices( $originalField );
$translatedChoices = $getChoices( $translatedField );

if ( ! is_array( $originalChoices ) || ! is_array( $translatedChoices ) ) {
return [];
}

$choicesMap = [];
$max = min( count( $originalChoices ), count( $translatedChoices ) );

for ( $i = 0; $i < $max; $i++ ) {
$choicesMap[ $translatedChoices[ $i ] ] = $originalChoices[ $i ];
}

return $choicesMap;
}

/**
* Restore labels in form data before processing conditional logic for form entry notifications.
*
* Clone-aware for repeater submissions.
*
* @param bool $process Whether to process the logic or not.
* @param array $fields List of submitted fields.
* @param array $form_data Form data and settings.
* @param int $id Notification ID.
*
* @return bool
*/
public function processNotificationConditionals( $process, $fields, $form_data, $id ) {
$conditionalLogicFields = WPForms_Conditional_Logic_Fields::instance();

$form_data = $this->restoreConditionalLabels( $form_data, $fields );

return $conditionalLogicFields->process_notification_conditionals( $process, $fields, $form_data, $id );
}

/**
* @param array $form_data Form data and settings.
* @param array $fields List of submitted fields.
*
* @return array
*/
private function restoreConditionalLabels( $form_data, $fields ) {
if ( empty( $form_data['fields'] ) || ! is_array( $form_data['fields'] ) ) {
return $form_data;
}

foreach ( $form_data['fields'] as $key => &$field ) {
if ( empty( $field['choices'] ) || ! is_array( $field['choices'] ) ) {
continue;
}

// Prefer exact key, else find the first clone "{$key}_N".
$submitted = $fields[ $key ] ?? null;
if ( null === $submitted ) {
foreach ( $fields as $k => $f ) {
if ( is_string( $k ) && preg_match( '/^' . preg_quote( (string) $key, '/' ) . '_\d+$/', $k ) ) {
$submitted = $f;
break;
}
}
}

if ( ! is_array( $submitted ) || ! isset( $submitted['value_raw'], $submitted['value'] ) ) {
continue;
}

foreach ( $field['choices'] as &$choice ) {
if ( isset( $choice['label'] ) && $choice['label'] === $submitted['value_raw'] ) {
$choice['label'] = $submitted['value'];
}
}
}

return $form_data;
}

}

Hi,

I can test this, but I have this setup on +30 sites and they have 5-10 forms on each, so doing this for about 250 forms, and teaching about 10 web editors to do it each time they create a new form, that is not feasable. Makeing a fix for the repeater fields in the WPForms Multilingual plugin seems like a more reasonable way forward. I don't want to "hack" the plugin each time there is a new official update either.

OK, but just to be sure: This is not a translated page, this is an original page in the default language (Swedish). So no translated fields are being involved here. But when I deactivate (or "patch") WPForms Multilingual, the error disappears.

Also, the numbers in the repeater fields are created dynamically in WPForms, when a user adds more fields in a form. I don't create (or translate) field 1_1, 1_2, 1_3 etc. There can be an infite number of repeater fields with an infinite number of numbers.

OK, I'll test it and come back.