File: /home/mciraet/www/wp-content/plugins/polylang-wc/src/strings.php
<?php
/**
* @package Polylang-WC
*/
use Automattic\WooCommerce\Blocks\Payments\PaymentMethodTypeInterface;
/**
* Manage the strings translations.
*
* @since 0.1
*/
class PLLWC_Strings {
/**
* List of gateway names integrated with the block API.
*
* @var string[]
*/
private $block_gateways = array();
/**
* Constructor.
*
* @since 0.1
*/
public function __construct() {
// Translate strings in emails.
add_action( 'pllwc_email_language', array( $this, 'translate_emails' ) );
if ( PLL() instanceof PLL_Frontend || PLL() instanceof PLL_REST_Request ) {
// Translate strings on frontend and in the checkout page (WC does a REST request to `/wp-json/wc/store/v1/cart`).
add_action( 'init', array( $this, 'translate_strings' ) );
}
if ( ! PLL() instanceof PLL_Frontend ) {
add_filter( 'woocommerce_attribute_label', array( $this, 'attribute_label' ), 10, 3 );
}
if ( PLL() instanceof PLL_Settings ) {
/*
* Register string the old way.
*/
add_action( 'init', array( $this, 'register_strings' ), 99 ); // Priority 99 in case gateways are registered in the same hook. See WooCommerce Invoice Gateway.
add_filter( 'pll_sanitize_string_translation', array( $this, 'sanitize_strings' ), 10, 3 );
}
/*
* Translate options the new way, mostly for gateways and shipping methods in checkout block.
*/
add_action( 'woocommerce_init', array( $this, 'translate_options' ) );
add_filter( 'woocommerce_shipping_zone_shipping_methods', array( $this, 'translate_shipping_methods' ) );
add_action( 'woocommerce_blocks_payment_method_type_registration', array( $this, 'translate_payment_method_blocks' ), 666 ); // Late!
add_action( 'wc_payment_gateways_initialized', array( $this, 'translate_payment_gateways' ) );
}
/**
* Returns the options to translate.
* Not called before the action 'init' to avoid loading WooCommerce translations sooner than WooCommerce.
*
* @since 1.0
*
* @return array
*/
protected static function get_options() {
return array(
'email_footer_text' => array( 'name' => __( 'Footer text', 'polylang-wc' ), 'multiline' => true ),
'demo_store_notice' => array( 'name' => __( 'Store notice text', 'polylang-wc' ), 'multiline' => true ),
'price_display_suffix' => array( 'name' => 'price_display_suffix' ),
'currency_pos' => array( 'name' => __( 'Currency position', 'polylang-wc' ) ),
'price_thousand_sep' => array( 'name' => __( 'Thousand separator', 'polylang-wc' ) ),
'price_decimal_sep' => array( 'name' => __( 'Decimal separator', 'polylang-wc' ) ),
'registration_privacy_policy_text' => array( 'name' => __( 'Registration privacy policy', 'polylang-wc' ), 'multiline' => true ),
'checkout_privacy_policy_text' => array( 'name' => __( 'Checkout privacy policy', 'polylang-wc' ), 'multiline' => true ),
'checkout_terms_and_conditions_checkbox_text' => array( 'name' => __( 'Terms and conditions', 'polylang-wc' ) ),
'email_from_name' => array( 'name' => 'email_from_name' ),
'email_from_address' => array( 'name' => 'email_from_address' ),
'email_header_image' => array( 'name' => __( 'Email header image', 'polylang-wc' ) ),
);
}
/**
* Tests whether an email property should be translated.
*
* @since 0.1
*
* @param string $prop Property name.
* @return bool
*/
protected function is_translated_email_property( $prop ) {
return 0 === strpos( $prop, 'subject' ) || 0 === strpos( $prop, 'heading' ) || 0 === strpos( $prop, 'additional_content' );
}
/**
* Tests whether a shipping property should be translated.
*
* @since 0.1
*
* @param string $prop Property name.
* @return bool
*/
protected function is_translated_shipping_property( $prop ) {
return 'title' === $prop;
}
/**
* Tests whether an email property input field should be multiline.
*
* @since 1.5.5
*
* @param string $prop Property name.
* @return bool
*/
protected function is_email_property_multiline( $prop ) {
return 'additional_content' === $prop;
}
/**
* Register sub strings.
*
* @since 0.1
*
* @param WC_Settings_API[] $objects Array of objects having properties to translate.
* @param callable $is_translated_cb Function testing if a property should be translated.
* @param callable $is_multiline_cb Function testing if the input field should be multiline (default to false).
* @return void
*/
protected function register_sub_options( $objects, $is_translated_cb, $is_multiline_cb = '__return_false' ) {
foreach ( $objects as $obj ) {
if ( ! isset( $obj->enabled ) || 'no' !== $obj->enabled ) {
foreach ( array_keys( $obj->form_fields ) as $prop ) {
if ( call_user_func( $is_translated_cb, $prop, $obj ) ) {
if ( ! empty( $obj->settings[ $prop ] ) ) {
pll_register_string( $prop . '_' . $obj->id, $obj->settings[ $prop ], 'WooCommerce', call_user_func( $is_multiline_cb, $prop ) );
} elseif ( ! empty( $obj->$prop ) ) {
pll_register_string( $prop . '_' . $obj->id, $obj->$prop, 'WooCommerce', call_user_func( $is_multiline_cb, $prop ) );
}
}
}
}
}
}
/**
* Translates options with `PLL_Translate_Option`.
*
* @since 1.9.5
*
* @return void
*/
public function translate_options() {
/**
* Local Pickup.
*/
new PLL_Translate_Option(
'pickup_location_pickup_locations',
array(
'*' => array(
'name' => 1,
'details' => 1,
),
),
array(
'context' => 'WooCommerce',
)
);
new PLL_Translate_Option(
'woocommerce_pickup_location_settings',
array(
'title' => 1,
),
array(
'context' => 'WooCommerce',
)
);
}
/**
* Translates shipping methods for a specific zone.
*
* @since 2.2
*
* @param WC_Shipping_Method[]|stdClass[] $methods Array of shipping method instances.
* @return WC_Shipping_Method[]|stdClass[]
*/
public function translate_shipping_methods( $methods ) {
foreach ( $methods as $method ) {
if ( ! $method instanceof WC_Shipping_Method ) {
continue;
}
new PLL_Translate_Option(
$method->get_instance_option_key(),
array( 'title' => true ),
array(
'context' => 'WooCommerce',
'sanitize_callback' => Closure::fromCallable( array( $this, 'sanitize_text_field' ) ),
)
);
}
return $methods;
}
/**
* Translates gateways integrated with the WooCommerce block integration API.
*
* @since 2.0
*
* @param Automattic\WooCommerce\Blocks\Integrations\IntegrationRegistry $integration_registry Woo integration registry.
* @return void
*/
public function translate_payment_method_blocks( $integration_registry ): void {
$gateways = $integration_registry->get_all_registered();
foreach ( $gateways as $gateway ) {
if ( ! $gateway instanceof PaymentMethodTypeInterface ) {
continue;
}
$this->block_gateways[] = $gateway->get_name();
/**
* Filters gateway option key for later translation.
* Useful if corresponding gateway overrides `WC_Settings_API::$plugin_id`.
*
* @since 2.0
*
* @param string $option_key The option key, default to the one that WooCommerce generates.
* @param PaymentMethodTypeInterface $gateway Current gateway from which option will be translated.
*/
$option_key = apply_filters( "pllwc_{$gateway->get_name()}_option_key", "woocommerce_{$gateway->get_name()}_settings", $gateway );
$this->translate_payment_gateway_option( $option_key );
}
}
/**
* Translates gateways *not* integrated with the WooCommerce block integration API.
* Done later than the blocks for backward compatibility.
*
* @since 2.0
*
* @param WC_Payment_Gateways $gateways Woo gateways registry.
* @return void
*/
public function translate_payment_gateways( $gateways ) {
foreach ( $gateways->payment_gateways() as $gateway ) {
if ( in_array( $gateway->id, $this->block_gateways, true ) ) {
continue;
}
$this->translate_payment_gateway_option( $gateway->get_option_key() );
}
}
/**
* Registers strings
*
* @since 0.1
*
* @return void
*/
public function register_strings() {
global $wpdb;
// Emails.
$this->register_sub_options(
WC_Emails::instance()->get_emails(),
array( $this, 'is_translated_email_property' ),
array( $this, 'is_email_property_multiline' )
);
// BACS Account details.
$woocommerce_bacs_accounts = get_option( 'woocommerce_bacs_accounts', array() );
if ( is_array( $woocommerce_bacs_accounts ) ) {
foreach ( $woocommerce_bacs_accounts as $account ) {
pll_register_string( __( 'Account name', 'polylang-wc' ), $account['account_name'], 'WooCommerce' );
pll_register_string( __( 'Bank name', 'polylang-wc' ), $account['bank_name'], 'WooCommerce' );
}
}
/*
* Loads shipping methods properly by calling `WC_Shipping_Zone::get_shipping_methods()`
* otherwise `WC_Shipping_Method` instances doesn't return a correct value in `WC_Shipping_Method::get_instance_option_key()`.
*/
WC_Shipping_Zones::get_zones();
// Shipping methods (backward compatibility with WC < 2.6, kept in WC 2.6+ for sites not using shipping zones),
// see `WC_Shipping::get_shipping_method_class_names()`.
$this->register_sub_options(
WC_Shipping::instance()->get_shipping_methods(),
array( $this, 'is_translated_shipping_property' )
);
// Strings as single option.
foreach ( self::get_options() as $string => $arr ) {
if ( $option = get_option( 'woocommerce_' . $string ) ) {
pll_register_string( $arr['name'], $option, 'WooCommerce', ! empty( $arr['multiline'] ) );
}
}
// Attributes labels.
foreach ( wc_get_attribute_taxonomies() as $attr ) {
pll_register_string( __( 'Attribute', 'polylang-wc' ), $attr->attribute_label, 'WooCommerce' );
}
// Tax rate labels.
$labels = $wpdb->get_col( "SELECT tax_rate_name FROM {$wpdb->prefix}woocommerce_tax_rates" );
foreach ( $labels as $label ) {
pll_register_string( __( 'Tax name', 'polylang-wc' ), $label, 'WooCommerce' );
}
// Local pickup.
$pickup_locations = get_option( 'pickup_location_pickup_locations', array() );
if ( is_array( $pickup_locations ) ) {
foreach ( $pickup_locations as $pickup_location ) {
if ( ! empty( $pickup_location['name'] ) ) {
pll_register_string( __( 'Local pickup location name', 'polylang-wc' ), $pickup_location['name'], 'WooCommerce' );
}
if ( ! empty( $pickup_location['details'] ) ) {
pll_register_string( __( 'Local pickup location details', 'polylang-wc' ), $pickup_location['details'], 'WooCommerce' );
}
}
}
$pickup_location_settings = get_option( 'woocommerce_pickup_location_settings', array() );
if ( is_array( $pickup_location_settings ) && ! empty( $pickup_location_settings['title'] ) ) {
pll_register_string( __( 'Local pickup title', 'polylang-wc' ), $pickup_location_settings['title'], 'WooCommerce' );
}
}
/**
* Sanitizes translated strings.
* This is done the same way WooCommerce does before they are saved.
*
* @since 0.1
*
* @param string $translation The string translation.
* @param string $name The name as defined in pll_register_string.
* @param string $context The context as defined in pll_register_string.
* @return string sanitized translation
*/
public function sanitize_strings( $translation, $name, $context ) {
if ( 'WooCommerce' !== $context ) {
return $translation;
}
switch ( $name ) {
// Account details.
case __( 'Account name', 'polylang-wc' ):
case __( 'Bank name', 'polylang-wc' ):
$translation = wc_clean( $translation );
break;
// Attributes labels.
case __( 'Attribute', 'polylang-wc' ):
$translation = wc_clean( $translation );
break;
// Tax rate labels.
case __( 'Tax name', 'polylang-wc' ):
$translation = wc_clean( $translation );
break;
// Local pickup.
case __( 'Local pickup location name', 'polylang-wc' ):
case __( 'Local pickup location details', 'polylang-wc' ):
case __( 'Local pickup title', 'polylang-wc' ):
$translation = wc_clean( $translation );
break;
// Prices options.
case 'price_display_suffix':
case __( 'Thousand separator', 'polylang-wc' ):
case __( 'Decimal separator', 'polylang-wc' ):
$translation = wc_clean( $translation );
break;
case __( 'Currency position', 'polylang-wc' ):
$translation = in_array( $translation, array( 'left', 'right', 'left_space', 'right_space' ) ) ?: get_option( 'woocommerce_currency_pos', 'left' );
break;
// Emails options.
case 'email_from_name':
$translation = wc_clean( $translation );
break;
case 'email_from_address':
$translation = sanitize_email( $translation );
break;
case __( 'Email header image', 'polylang-wc' ):
$translation = sanitize_url( $translation );
break;
// Other options.
default:
$is_text_field = in_array( $name, wp_list_pluck( self::get_options(), 'name' ), true ) ||
$this->is_translated_email_property( $name ) ||
$this->is_translated_shipping_property( $name );
if ( $is_text_field ) {
$translation = wp_kses_post( trim( $translation ) );
}
break;
}
return $translation;
}
/**
* Setups actions and filters to translate strings.
*
* @since 0.1
*
* @return void
*/
public function translate_strings() {
// Gateway instructions in emails.
add_action( 'woocommerce_email_before_order_table', array( $this, 'translate_instructions' ), 5 ); // Before WooCommerce.
// Gateway instructions in thankyou page.
add_action( 'woocommerce_before_thankyou', array( $this, 'translate_instructions' ) ); // Since WooCommerce 3.7.
add_filter( 'woocommerce_bacs_accounts', array( $this, 'translate_bacs_accounts' ) );
if ( isset( $_COOKIE[ PLL_COOKIE ] ) && pll_current_language() !== $_COOKIE[ PLL_COOKIE ] ) {
add_action( 'woocommerce_before_calculate_totals', array( $this, 'reset_shipping_language' ) );
}
// Options.
foreach ( array_keys( self::get_options() ) as $string ) {
add_filter( 'option_woocommerce_' . $string, 'pll__' );
}
// Attributes.
add_filter( 'woocommerce_attribute_taxonomies', array( $this, 'attribute_taxonomies' ) );
add_filter( 'woocommerce_attribute_label', 'pll__' );
// Tax rate labels.
add_filter( 'woocommerce_rate_label', 'pll__' );
add_filter( 'woocommerce_find_rates', array( $this, 'find_rates' ) );
add_filter( 'woocommerce_order_get_tax_totals', array( $this, 'set_tax_label' ) );
// Gateways.
add_filter( 'woocommerce_gateway_title', 'pll__' );
add_filter( 'woocommerce_gateway_description', 'pll__' );
// Shipping methods.
add_filter( 'woocommerce_package_rates', array( $this, 'translate_shipping' ) );
// Shipping methods since WooCommerce 2.6.
add_filter( 'woocommerce_shipping_rate_label', 'pll__' );
}
/**
* Translates emails subject, heading and footer.
*
* @since 0.1
*
* @return void
*/
public function translate_emails() {
add_filter( 'woocommerce_email_get_option', array( $this, 'translate_email_option' ), 10, 4 );
// These filters are added by Polylang but not on admin.
foreach ( array( 'option_blogname', 'option_blogdescription', 'option_date_format', 'option_time_format' ) as $filter ) {
add_filter( $filter, 'pll__', 1 );
}
// Other strings.
$this->translate_strings();
// In case mails are sent in bulk, we need to reset some settings such as the subject and heading for each email sent.
foreach ( WC_Emails::instance()->get_emails() as $email ) {
$email->init_settings();
}
}
/**
* Translates emails options such as the subject and heading.
* Hooked to the filter 'woocommerce_email_get_option'.
*
* @since 0.8
*
* @param string $value String to translate.
* @param WC_Email $email Instance of WC_Email, not used.
* @param string $_value Same as $value, not used.
* @param string $key Option name.
* @return string
*/
public function translate_email_option( $value, $email, $_value, $key ) {
if ( $this->is_translated_email_property( $key ) ) {
$value = pll__( $value );
}
return $value;
}
/**
* Translates the gateway instructions in thankyou page or email.
*
* @since 0.1
*
* @return void
*/
public function translate_instructions() {
$gateways = WC_Payment_Gateways::instance()->get_available_payment_gateways();
foreach ( $gateways as $key => $gateway ) {
if ( isset( $gateway->instructions ) ) {
$gateways[ $key ]->instructions = pll__( $gateway->instructions );
}
}
}
/**
* Translate the account names and bank names for the BACS gateway.
*
* @since 1.2
*
* @param array $accounts Array of account details.
* @return array
*/
public function translate_bacs_accounts( $accounts ) {
if ( ! is_array( $accounts ) ) {
return $accounts;
}
foreach ( $accounts as $k => $account ) {
$accounts[ $k ]['account_name'] = pll__( $account['account_name'] );
$accounts[ $k ]['bank_name'] = pll__( $account['bank_name'] );
}
return $accounts;
}
/**
* Translate the shipping methods titles.
*
* @since 0.1
*
* @param WC_Shipping_Rate[] $rates Array of WC_Shipping_Rate objects.
* @return array
*/
public function translate_shipping( $rates ) {
foreach ( $rates as $key => $rate ) {
$rates[ $key ]->set_label( pll__( $rate->get_label() ) );
}
return $rates;
}
/**
* Reset the shipping in session in case a user switches the language.
*
* @since 0.1
*
* @return void
*/
public function reset_shipping_language() {
unset( WC()->session->shipping_for_package ); // Since WooCommerce 2.5.
}
/**
* Translates the attributes labels.
*
* @since 0.1
*
* @param stdClass[] $attribute_taxonomies Attribute taxonomies.
* @return stdClass[]
*/
public function attribute_taxonomies( $attribute_taxonomies ) {
foreach ( $attribute_taxonomies as $attr ) {
$attr->attribute_label = pll__( $attr->attribute_label );
}
return $attribute_taxonomies;
}
/**
* Translates the tax rates labels.
*
* @since 1.2
*
* @param array $rates An array of tax rates.
* @return array
*/
public function find_rates( $rates ) {
foreach ( $rates as $k => $rate ) {
$rates[ $k ]['label'] = pll__( $rate['label'] );
}
return $rates;
}
/**
* Refreshes the rate labels on orders. Required to display the labels in the right language when sending emails.
*
* @since 2.1.4
* @see WC_Abstract_Order::get_tax_totals()
*
* @param array $tax_totals Array of tax-data.
* @return array
*
* @phpstan-param array<
* string,
* object{
* id: int,
* rate_id: int,
* is_compound: bool,
* label: string,
* amount: float,
* formatted_amount: string
* }&\stdClass
* > $tax_totals
*/
public function set_tax_label( $tax_totals ) {
foreach ( $tax_totals as $code => $tax ) {
$tax_totals[ $code ]->label = \WC_Tax::get_rate_label( $tax->rate_id );
}
return $tax_totals;
}
/**
* Translates an attribute label on admin.
* Needed for variations titles since WC 3.0.
*
* @since 0.7
*
* @param string $label Attribute label.
* @param string $name Taxonomy name, not used.
* @param WC_Product|string $product Product data or empty string.
* @return string
*/
public function attribute_label( $label, $name, $product ) {
// Don't translate the attribute label when exporting a product, as it would create new attributes if the file is imported back.
if ( $product instanceof WC_Product && ! doing_action( 'wp_ajax_woocommerce_do_ajax_product_export' ) ) {
$data_store = PLLWC_Data_Store::load( 'product_language' );
$lang = $data_store->get_language( $product->get_id() );
$language = PLL()->model->get_language( $lang );
if ( $language ) {
$mo = new PLL_MO();
$mo->import_from_db( $language );
return $mo->translate( $label );
}
}
return $label;
}
/**
* Sanitizes text, used to clean up options.
*
* @since 2.0
*
* @param string $string The string to sanitize.
* @param string $name The option name as defined in `PLL_Translate_Option`.
* @param string $context The context as defined in `PLL_Translate_Option`.
* @return string The sanitized string.
*/
private function sanitize_text_field( $string, $name, $context ): string {
if ( 'WooCommerce' !== $context || ! in_array( $name, array( 'title', 'description', 'instructions' ), true ) ) {
return $string;
}
return wp_kses_post( trim( $string ) );
}
/**
* Registers and translates strings in an option for gateway.
*
* @since 2.0
*
* @param string $option_key The gateway option key.
* @return void
*/
private function translate_payment_gateway_option( $option_key ) {
new PLL_Translate_Option(
$option_key,
array(
'title' => true,
'description' => true,
'instructions' => true,
),
array(
'context' => 'WooCommerce',
'sanitize_callback' => Closure::fromCallable( array( $this, 'sanitize_text_field' ) ),
)
);
}
}