JetEngine - Custom callback - Units converter

code

// place the code in the child theme functions.php or a custom code snippets plugin, like FluentSnippets

// What do this code

// This code adds a custom callback to the JetEngine built-in dynamic field widget. The callback name is: Convert Units
// The supported measurement units are: Millimeters (mm), Centimeters (cm), Meters (m), Kilometers (km), Inches (in),
Feet (ft), Yards (yd), Miles, Milliliters (ml), Deciliters (dl), Liters (l), Grams (g), Dekagrams (dkg), Kilograms (kg),
Pounds (lb), Bytes, Megabytes (MB), Gigabytes (GB), Watts (W), Kilowatts (kW), Megawatts (MW), Gigawatts (GW), Volts (V),
Kilometers per hour (km/h), Miles per hour (mph), Seconds (s), Minutes (min), Hours (h), Days (d),
Celsius (°C), Kelvin (K), Fahrenheit (°F). 

// How to use

// It's simple to use: select the "Convert Units" option in the Filter Field Output -> callback list. 
// Then, in the two displayed select fields, choose the unit of the meta default value in one, and the unit to convert
// to in the other. You can also set the number format. Note that cross-unit conversions and non-linear calculations are not possible.


/**
 * Adds a new callback to convert measurements with source and target units.
 */

// Add the callback to allowed callbacks
add_filter( 'jet-engine/listings/allowed-callbacks', 'add_measurement_callback' );
add_filter( 'jet-engine/listing/dynamic-field/callback-args', 'add_measurement_callback_args', 10, 3 );
add_filter( 'jet-engine/listings/allowed-callbacks-args', 'add_measurement_callback_controls' );

function add_measurement_callback( $callbacks ) {
	$callbacks['unit_converter'] = 'Convert units';
	return $callbacks;
}

function add_measurement_callback_controls( $args ) {
	$unit_options = array(
		'mm'    => esc_html__( 'Millimeters (mm)', 'jet-engine' ),
		'cm'    => esc_html__( 'Centimeters (cm)', 'jet-engine' ),
		'm'     => esc_html__( 'Meters (m)', 'jet-engine' ),
		'km'    => esc_html__( 'Kilometers (km)', 'jet-engine' ),
		'in'    => esc_html__( 'Inches (in)', 'jet-engine' ),
		'ft'    => esc_html__( 'Feet (ft)', 'jet-engine' ),
		'yd'    => esc_html__( 'Yards (yd)', 'jet-engine' ),
		'mile'  => esc_html__( 'Miles', 'jet-engine' ),
		'ml'    => esc_html__( 'Milliliters (ml)', 'jet-engine' ),
		'dl'    => esc_html__( 'Deciliters (dl)', 'jet-engine' ),
		'l'     => esc_html__( 'Liters (l)', 'jet-engine' ),
		'g'     => esc_html__( 'Grams (g)', 'jet-engine' ),
		'dkg'   => esc_html__( 'Dekagrams (dkg)', 'jet-engine' ),
		'kg'    => esc_html__( 'Kilograms (kg)', 'jet-engine' ),
		'lb'    => esc_html__( 'Pounds (lb)', 'jet-engine' ),
		'byte'  => esc_html__( 'Bytes', 'jet-engine' ),
		'mb'    => esc_html__( 'Megabytes (MB)', 'jet-engine' ),
		'gb'    => esc_html__( 'Gigabytes (GB)', 'jet-engine' ),
		'w'     => esc_html__( 'Watts (W)', 'jet-engine' ),
		'kw'    => esc_html__( 'Kilowatts (kW)', 'jet-engine' ),
		'mw'    => esc_html__( 'Megawatts (MW)', 'jet-engine' ),
		'gw'    => esc_html__( 'Gigawatts (GW)', 'jet-engine' ),
		'v'     => esc_html__( 'Volts (V)', 'jet-engine' ),
		'kmph'  => esc_html__( 'Kilometers per hour (km/h)', 'jet-engine' ),
		'mph'   => esc_html__( 'Miles per hour (mph)', 'jet-engine' ),
		's'     => esc_html__( 'Seconds (s)', 'jet-engine' ),
		'min'   => esc_html__( 'Minutes (min)', 'jet-engine' ),
		'h'     => esc_html__( 'Hours (h)', 'jet-engine' ),
		'd'     => esc_html__( 'Days (d)', 'jet-engine' ),
		'c'     => esc_html__( 'Celsius (°C)', 'jet-engine' ),
		'k'     => esc_html__( 'Kelvin (K)', 'jet-engine' ),
		'f'     => esc_html__( 'Fahrenheit (°F)', 'jet-engine' ),
	);

	$args['source_measurement_unit'] = array(
		'label'   => esc_html__( 'Source Measurement Unit', 'jet-engine' ),
		'type'    => 'select',
		'default' => 'cm',
		'options' => $unit_options,
		'condition' => array(
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
		),
	);

	$args['target_measurement_unit'] = array(
		'label'   => esc_html__( 'Target Measurement Unit', 'jet-engine' ),
		'type'    => 'select',
		'default' => 'cm',
		'options' => $unit_options,
		'condition' => array(
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
		),
	);

	$args['custom_format'] = array(
		'label'   => esc_html__( 'Custom Format', 'jet-engine' ),
		'type'    => 'switcher',
		'default' => '',
		'return_value' => 'yes',
		'condition' => array(
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
		),
	);

	$args['hide_unit'] = array(
		'label'   => esc_html__( 'Hide Unit', 'jet-engine' ),
		'type'    => 'switcher',
		'default' => '',
		'return_value' => 'yes',
		'condition' => [
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
			'custom_format'        => 'yes',
		],
	);

	$args['decimal_point'] = array(
		'label'       => esc_html__( 'Decimal Point', 'jet-engine' ),
		'type'        => 'text',
		'default'     => '.',
		'condition'   => [
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
			'custom_format'        => 'yes',
		],
	);

	$args['thousand_separator'] = array(
		'label'       => esc_html__( 'Thousand Separator', 'jet-engine' ),
		'type'        => 'text',
		'default'     => ',',
		'condition'   => [
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
			'custom_format'        => 'yes',
		],
	);

	$args['decimal_points'] = array(
		'label'       => esc_html__( 'Decimal Points', 'jet-engine' ),
		'type'        => 'number',
		'default'     => 0,
		'min'         => 0,
		'condition'   => [
			'dynamic_field_filter' => 'yes',
			'filter_callback'      => array( 'unit_converter' ),
			'custom_format'        => 'yes',
		],
	);

	return $args;
}

function unit_converter( $field_value = null, $source_unit = 'cm', $target_unit = 'cm', $custom_format = false, $hide_unit = false, $decimal_point = '.', $thousand_separator = ',', $decimal_points = 0 ) {

	// Store the original value for use in the macro
	global $original_field_value;
	$original_field_value = $field_value;

	// Remove any non-numeric characters except for dots and commas
	$field_value = preg_replace('/[^0-9.,]/', '', $field_value);

	if ( ! is_numeric( str_replace( array( ',', '.' ), '', $field_value ) ) ) {
		return $field_value;
	}

	// Replace commas with dots and convert to float
	$field_value = floatval( str_replace( ',', '.', $field_value ) );

	// Define categories for units
	$unit_categories = array(
		'length' => array('mm', 'cm', 'm', 'km', 'in', 'ft', 'yd', 'mile'),
		'volume' => array('ml', 'dl', 'l'),
		'weight' => array('g', 'dkg', 'kg', 'lb'),
		'data' => array('byte', 'mb', 'gb'),
		'power' => array('w', 'kw', 'mw', 'gw'),
		'speed' => array('kmph', 'mph'),
		'time' => array('s', 'min', 'h', 'd'),
		'temperature' => array('c', 'k', 'f')
	);

	// Find the category of the source and target units
	$source_category = null;
	$target_category = null;
	foreach ($unit_categories as $category => $units) {
		if (in_array($source_unit, $units)) {
			$source_category = $category;
		}
		if (in_array($target_unit, $units)) {
			$target_category = $category;
		}
	}

	// If the source and target units are not in the same category, return an error
	if ($source_category !== $target_category) {
		return 'Invalid conversion';
	}

	// Conversion factors to base unit
	$conversion_factors_to_base = array(
		'mm'    => 0.001,
		'cm'    => 0.01,
		'm'     => 1,
		'km'    => 1000,
		'in'    => 0.0254,
		'ft'    => 0.3048,
		'yd'    => 0.9144,
		'mile'  => 1609.34,
		'ml'    => 0.000001,
		'dl'    => 0.0001,
		'l'     => 0.001,
		'g'     => 0.001,
		'dkg'   => 0.01,
		'kg'    => 1,
		'lb'    => 0.453592,
		'byte'  => 0.000000001,
		'mb'    => 0.000001,
		'gb'    => 0.001,
		'w'     => 1,
		'kw'    => 1000,
		'mw'    => 1000000,
		'gw'    => 1000000000,
		'v'     => 1,
		'kmph'  => 0.277778,
		'mph'   => 0.44704,
		's'     => 1,
		'min'   => 60,
		'h'     => 3600,
		'd'     => 86400,
		'c'     => 1, // Handle temperature conversion separately
		'k'     => 1,
		'f'     => 1,
	);

	// Conversion factors from base unit to target unit
	$conversion_factors_from_base = array(
		'mm'    => 1000,
		'cm'    => 100,
		'm'     => 1,
		'km'    => 0.001,
		'in'    => 39.3701,
		'ft'    => 3.28084,
		'yd'    => 1.09361,
		'mile'  => 0.000621371,
		'ml'    => 1000000,
		'dl'    => 10000,
		'l'     => 1000,
		'g'     => 1000,
		'dkg'   => 100,
		'kg'    => 1,
		'lb'    => 2.20462,
		'byte'  => 1000000000,
		'mb'    => 1000000,
		'gb'    => 1000,
		'w'     => 1,
		'kw'    => 0.001,
		'mw'    => 0.000001,
		'gw'    => 0.000000001,
		'v'     => 1,
		'kmph'  => 3.6,
		'mph'   => 2.23694,
		's'     => 1,
		'min'   => 0.0166667,
		'h'     => 0.000277778,
		'd'     => 0.0000115741,
		'c'     => 1,
		'k'     => 1,
		'f'     => 1,
	);

	// Handle temperature conversion separately
	if ( in_array($source_unit, ['c', 'k', 'f']) || in_array($target_unit, ['c', 'k', 'f']) ) {
		// Convert source to Kelvin
		switch ($source_unit) {
			case 'c':
				$value_in_base_unit = $field_value + 273.15;
				break;
			case 'f':
				$value_in_base_unit = ($field_value - 32) / 1.8 + 273.15;
				break;
			case 'k':
				$value_in_base_unit = $field_value;
				break;
		}
		// Convert from Kelvin to target
		switch ($target_unit) {
			case 'c':
				$converted_value = $value_in_base_unit - 273.15;
				break;
			case 'f':
				$converted_value = ($value_in_base_unit - 273.15) * 1.8 + 32;
				break;
			case 'k':
				$converted_value = $value_in_base_unit;
				break;
		}
	} else {
		// Convert source value to base unit
		if ( isset( $conversion_factors_to_base[ $source_unit ] ) ) {
			$value_in_base_unit = $field_value * $conversion_factors_to_base[ $source_unit ];
		} else {
			// If the source unit is not recognized, return the original value
			return $field_value . ' ' . $source_unit;
		}

		// Convert value in base unit to target unit
		if ( isset( $conversion_factors_from_base[ $target_unit ] ) ) {
			$converted_value = $value_in_base_unit * $conversion_factors_from_base[ $target_unit ];
		} else {
			// If the target unit is not recognized, return the value in base unit
			return $value_in_base_unit . ' ' . $source_unit;
		}
	}

	// Apply custom formatting
	if ( $custom_format ) {
		$converted_value = number_format( $converted_value, $decimal_points, $decimal_point, $thousand_separator );
	}

	if ( $custom_format && $hide_unit ) {
		return $converted_value;
	} else {
		return $converted_value . ' ' . $target_unit;
	}
}

function add_measurement_callback_args( $args, $callback, $settings = array() ) {

	if ( 'unit_converter' === $callback ) {
		$args[] = isset( $settings['source_measurement_unit'] ) ? $settings['source_measurement_unit'] : 'cm';
		$args[] = isset( $settings['target_measurement_unit'] ) ? $settings['target_measurement_unit'] : 'cm';
		$args[] = isset( $settings['custom_format'] ) ? $settings['custom_format'] : false;
		$args[] = isset( $settings['hide_unit'] ) ? $settings['hide_unit'] : false;
		$args[] = isset( $settings['decimal_point'] ) ? $settings['decimal_point'] : '.';
		$args[] = isset( $settings['thousand_separator'] ) ? $settings['thousand_separator'] : ',';
		$args[] = isset( $settings['decimal_points'] ) ? $settings['decimal_points'] : 0;
	}

	return $args;
}