*/
function yit_wpml_object_id( $element_id, $element_type = 'post', $return_original_if_missing = false, $language_code = null ) {
if ( function_exists( 'wpml_object_id_filter' ) ) {
return wpml_object_id_filter( $element_id, $element_type, $return_original_if_missing, $language_code );
} elseif ( function_exists( 'icl_object_id' ) ) {
return icl_object_id( $element_id, $element_type, $return_original_if_missing, $language_code );
} else {
return $element_id;
}
}
}
if ( ! function_exists( 'yith_get_formatted_price' ) ) {
/**
* Format the price with a currency symbol.
*
* @param float $price The price.
* @param array $args Arguments.
*
* @return string
*/
function yith_get_formatted_price( $price, $args = array() ) {
$defaults = array(
'ex_tax_label' => false,
'currency' => '',
'decimal_separator' => wc_get_price_decimal_separator(),
'thousand_separator' => wc_get_price_thousand_separator(),
'decimals' => wc_get_price_decimals(),
'price_format' => get_woocommerce_price_format(),
);
$args = wp_parse_args( $args, $defaults );
$args = apply_filters( 'wc_price_args', $args );
list ( $decimals, $decimal_separator, $thousand_separator, $price_format, $currency ) = yith_plugin_fw_extract( $args, 'decimals', 'decimal_separator', 'thousand_separator', 'price_format', 'currency' );
$negative = $price < 0;
$price = apply_filters( 'raw_woocommerce_price', floatval( $negative ? $price * - 1 : $price ) );
$price = apply_filters( 'formatted_woocommerce_price', number_format( $price, $decimals, $decimal_separator, $thousand_separator ), $price, $decimals, $decimal_separator, $thousand_separator );
if ( apply_filters( 'woocommerce_price_trim_zeros', false ) && $decimals > 0 ) {
$price = wc_trim_zeros( $price );
}
$formatted_price = ( $negative ? '-' : '' ) . sprintf( $price_format, get_woocommerce_currency_symbol( $currency ), $price );
$return = $formatted_price;
return apply_filters( 'wc_price', $return, $price, $args );
}
}
if ( ! function_exists( 'yith_get_terms' ) ) {
/**
* Get terms.
*
* @param array $args Arguments.
*
* @return array|int|WP_Error
* @deprecated 3.5 | use get_terms instead
*/
function yith_get_terms( $args ) {
global $wp_version;
if ( version_compare( $wp_version, '4.5', '>=' ) ) {
$terms = get_terms( $args );
} else {
$terms = get_terms( $args['taxonomy'], $args );
}
return $terms;
}
}
if ( ! function_exists( 'yith_field_deps_data' ) ) {
/**
* Retrieve the field deps HTML data.
*
* @param array $field The field.
*
* @return string
*/
function yith_field_deps_data( $field ) {
$deps_data = '';
if ( isset( $field['deps'] ) && ( isset( $field['deps']['ids'] ) || isset( $field['deps']['id'] ) ) && ( isset( $field['deps']['values'] ) || isset( $field['deps']['value'] ) ) ) {
$deps = $field['deps'];
$id = isset( $deps['target-id'] ) ? $deps['target-id'] : $field['id'];
$dep_id = isset( $deps['id'] ) ? $deps['id'] : $deps['ids'];
$dep_values = isset( $deps['value'] ) ? $deps['value'] : $deps['values'];
$dep_type = isset( $deps['type'] ) ? $deps['type'] : 'fadeIn';
$deps_data = 'data-dep-target="' . esc_attr( $id ) . '" data-dep-id="' . esc_attr( $dep_id ) . '" data-dep-value="' . esc_attr( $dep_values ) . '" data-dep-type="' . esc_attr( $dep_type ) . '"';
}
return $deps_data;
}
}
if ( ! function_exists( 'yith_panel_field_deps_data' ) ) {
/**
* Retrieve the panel field deps HTML data.
*
* @param array $field The field.
* @param YIT_Plugin_Panel|YIT_Plugin_Panel_WooCommerce $panel The panel object.
*
* @return string
*/
function yith_panel_field_deps_data( $field, $panel ) {
$deps_data = '';
if ( isset( $field['deps'] ) && ( isset( $field['deps']['ids'] ) || isset( $field['deps']['id'] ) ) && isset( $field['deps']['values'] ) ) {
$dep_id = isset( $field['deps']['id'] ) ? $field['deps']['id'] : $field['deps']['ids'];
$field['deps']['ids'] = $panel->get_id_field( $dep_id );
$field['deps']['id'] = $panel->get_id_field( $dep_id );
$field['id'] = $panel->get_id_field( $field['id'] );
$deps_data = yith_field_deps_data( $field );
}
return $deps_data;
}
}
if ( ! function_exists( 'yith_plugin_fw_get_field' ) ) {
/**
* Retrieve a field.
*
* @param array $field The field.
* @param false $echo Set to true to print the field directly; false otherwise.
* @param bool $show_container Set to true to show the container; false otherwise.
*
* @return false|string
*/
function yith_plugin_fw_get_field( $field, $echo = false, $show_container = true ) {
if ( empty( $field['type'] ) ) {
return '';
}
if ( ! isset( $field['value'] ) ) {
$field['value'] = '';
}
if ( ! isset( $field['name'] ) ) {
$field['name'] = '';
}
if ( ! isset( $field['custom_attributes'] ) ) {
$field['custom_attributes'] = '';
} elseif ( is_array( $field['custom_attributes'] ) ) {
// Let's build custom attributes as string.
$custom_attributes = array();
foreach ( $field['custom_attributes'] as $attribute => $attribute_value ) {
$custom_attributes[] = esc_attr( $attribute ) . '="' . esc_attr( $attribute_value ) . '"';
}
$field['custom_attributes'] = implode( ' ', $custom_attributes );
}
if ( ! isset( $field['default'] ) && isset( $field['std'] ) ) {
$field['default'] = $field['std'];
}
$field_template = yith_plugin_fw_get_field_template_path( $field );
if ( ! isset( $field['id'] ) ) {
static $field_number = 1;
$field['id'] = "yith-plugin-fw-field__{$field_number}";
$field_number ++;
}
if ( $field_template ) {
if ( ! $echo ) {
ob_start();
}
if ( $show_container ) {
echo '';
}
do_action( 'yith_plugin_fw_get_field_before', $field );
do_action( 'yith_plugin_fw_get_field_' . $field['type'] . '_before', $field );
include $field_template;
do_action( 'yith_plugin_fw_get_field_after', $field );
do_action( 'yith_plugin_fw_get_field_' . $field['type'] . '_after', $field );
if ( $show_container ) {
echo '
';
}
if ( ! $echo ) {
return ob_get_clean();
}
}
return '';
}
}
if ( ! function_exists( 'yith_plugin_fw_get_field_template_path' ) ) {
/**
* Retrieve the field template path.
*
* @param array $field The field.
*
* @return false|string
*/
function yith_plugin_fw_get_field_template_path( $field ) {
if ( empty( $field['type'] ) ) {
return false;
}
$field_template = YIT_CORE_PLUGIN_TEMPLATE_PATH . '/fields/' . sanitize_title( $field['type'] ) . '.php';
$field_template = apply_filters( 'yith_plugin_fw_get_field_template_path', $field_template, $field );
return file_exists( $field_template ) ? $field_template : false;
}
}
if ( ! function_exists( 'yith_plugin_fw_html_data_to_string' ) ) {
/**
* Transform data array to HTML data.
*
* @param array $data The array of data.
* @param false $echo Set to true to print it directly; false otherwise.
*
* @return string
*/
function yith_plugin_fw_html_data_to_string( $data = array(), $echo = false ) {
$html_data = '';
if ( is_array( $data ) ) {
foreach ( $data as $key => $value ) {
$data_attribute = "data-{$key}";
$data_value = ! is_array( $value ) ? $value : implode( ',', $value );
$html_data .= ' ' . esc_attr( $data_attribute ) . '="' . esc_attr( $data_value ) . '"';
}
$html_data .= ' ';
}
if ( $echo ) {
echo $html_data; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
return $html_data;
}
}
}
if ( ! function_exists( 'yith_plugin_fw_get_icon' ) ) {
/**
* Retrieve an icon.
*
* @param string $icon The icon.
* @param array $args Array of arguments (such as html_tag, class, style, filter_suffix).
*
* @return string
*/
function yith_plugin_fw_get_icon( $icon = '', $args = array() ) {
return YIT_Icons()->get_icon( $icon, $args );
}
}
if ( ! function_exists( 'yith_plugin_fw_is_true' ) ) {
/**
* Is something true?
*
* @param string|bool|int $value The value to check for.
*
* @return bool
*/
function yith_plugin_fw_is_true( $value ) {
return true === $value || 1 === $value || '1' === $value || 'yes' === $value || 'true' === $value;
}
}
if ( ! function_exists( 'yith_plugin_fw_enqueue_enhanced_select' ) ) {
/**
* Enqueue the enhanced select style and script.
*/
function yith_plugin_fw_enqueue_enhanced_select() {
wp_enqueue_script( 'yith-enhanced-select' );
$select2_style_to_enqueue = function_exists( 'WC' ) ? 'woocommerce_admin_styles' : 'yith-select2-no-wc';
wp_enqueue_style( $select2_style_to_enqueue );
}
}
if ( ! function_exists( 'yit_add_select2_fields' ) ) {
/**
* Add select 2.
*
* @param array $args The arguments.
*/
function yit_add_select2_fields( $args = array() ) {
$default = array(
'type' => 'hidden',
'class' => '',
'id' => '',
'name' => '',
'data-placeholder' => '',
'data-allow_clear' => false,
'data-selected' => '',
'data-multiple' => false,
'data-action' => '',
'value' => '',
'style' => '',
'custom-attributes' => array(),
);
$args = wp_parse_args( $args, $default );
$custom_attributes = array();
foreach ( $args['custom-attributes'] as $attribute => $attribute_value ) {
$custom_attributes[] = esc_attr( $attribute ) . '="' . esc_attr( $attribute_value ) . '"';
}
$custom_attributes = implode( ' ', $custom_attributes );
if ( ! function_exists( 'WC' ) || version_compare( WC()->version, '2.7.0', '>=' ) ) {
if ( true === $args['data-multiple'] && substr( $args['name'], - 2 ) !== '[]' ) {
$args['name'] = $args['name'] . '[]';
}
$select2_template_name = 'select2.php';
} else {
if ( false === $args['data-multiple'] && is_array( $args['data-selected'] ) ) {
$args['data-selected'] = current( $args['data-selected'] );
}
$select2_template_name = 'select2-wc-2.6.php';
}
$template = YIT_CORE_PLUGIN_TEMPLATE_PATH . '/fields/resources/' . $select2_template_name;
if ( file_exists( $template ) ) {
include $template;
}
}
}
if ( ! function_exists( 'yith_plugin_fw_get_version' ) ) {
/**
* Retrieve the Plugin Framework version.
*
* @return string
*/
function yith_plugin_fw_get_version() {
$plugin_fw_data = get_file_data( trailingslashit( YIT_CORE_PLUGIN_PATH ) . 'init.php', array( 'Version' => 'Version' ) );
return $plugin_fw_data['Version'];
}
}
if ( ! function_exists( 'yith_get_premium_support_url' ) ) {
/**
* Return the url for My Account > Support dashboard
*
* @return string The complete string, if the main string is not empty or null
* @since 2.0.0
* @deprecated 3.5
*/
function yith_get_premium_support_url() {
return 'https://yithemes.com/my-account/support/dashboard/';
}
}
if ( ! function_exists( 'yith_plugin_fw_is_panel' ) ) {
/**
* Is this a Plugin Framework panel?
*
* @return bool
*/
function yith_plugin_fw_is_panel() {
$panel_screen_id = 'yith-plugins_page';
$screen = function_exists( 'get_current_screen' ) ? get_current_screen() : null;
return $screen instanceof WP_Screen && strpos( $screen->id, $panel_screen_id ) !== false;
}
}
if ( ! function_exists( 'yith_plugin_fw_force_regenerate_plugin_update_transient' ) ) {
/**
* Delete the update plugins transient
*
* @return void
* @since 1.0
* @see update_plugins transient and pre_set_site_transient_update_plugins hooks
* @author Andrea Grillo
*/
function yith_plugin_fw_force_regenerate_plugin_update_transient() {
delete_site_transient( 'update_plugins' );
}
}
if ( ! function_exists( 'yith_plugin_fw_is_gutenberg_enabled' ) ) {
/**
* Is Gutenberg enabled?
*
* @return bool
*/
function yith_plugin_fw_is_gutenberg_enabled() {
return function_exists( 'YITH_Gutenberg' );
}
}
if ( ! function_exists( 'yith_plugin_fw_gutenberg_add_blocks' ) ) {
/**
* Add new blocks to Gutenberg
*
* @param string|array $blocks Blocks to add.
*
* @return bool true if add a new blocks, false otherwise
* @author Andrea Grillo
*/
function yith_plugin_fw_gutenberg_add_blocks( $blocks ) {
$added = false;
if ( yith_plugin_fw_is_gutenberg_enabled() ) {
// Add blocks.
$added = YITH_Gutenberg()->add_blocks( $blocks );
// Add blocks arguments.
if ( $added ) {
YITH_Gutenberg()->set_block_args( $blocks );
}
}
return $added;
}
}
if ( ! function_exists( 'yith_plugin_fw_gutenberg_get_registered_blocks' ) ) {
/**
* Return an array with the registered blocks
*
* @return array
*/
function yith_plugin_fw_gutenberg_get_registered_blocks() {
return yith_plugin_fw_is_gutenberg_enabled() ? YITH_Gutenberg()->get_registered_blocks() : array();
}
}
if ( ! function_exists( 'yith_plugin_fw_gutenberg_get_to_register_blocks' ) ) {
/**
* Return an array with the blocks to register
*
* @return array
*/
function yith_plugin_fw_gutenberg_get_to_register_blocks() {
return yith_plugin_fw_is_gutenberg_enabled() ? YITH_Gutenberg()->get_to_register_blocks() : array();
}
}
if ( ! function_exists( 'yith_plugin_fw_get_default_logo' ) ) {
/**
* Get the default SVG logo
*
* @return string default logo image url
*/
function yith_plugin_fw_get_default_logo() {
return YIT_CORE_PLUGIN_URL . '/assets/images/yith-icon.svg';
}
}
if ( ! function_exists( 'yith_set_wrapper_class' ) ) {
/**
* Return the class for the new plugin panel style.
*
* @param array|string $class List of additional classes to add inside the panel wrapper.
*
* @return string
* @author Emanuela Castorina
*/
function yith_set_wrapper_class( $class = '' ) {
$new_class = 'yith-plugin-ui';
$class = ( ! empty( $class ) && is_array( $class ) ) ? implode( ' ', $class ) : $class;
return $new_class . ' ' . $class;
}
}
if ( ! function_exists( 'yith_get_date_formats' ) ) {
/**
* Get all available date format.
*
* @param bool $js JS date format or not.
*
* @return array
* @author Salvatore Strano
* @since 3.1
* @deprecated 3.5 | use yith_get_date_formats() instead
*/
function yith_get_date_format( $js = true ) {
return yith_get_date_formats( $js );
}
}
if ( ! function_exists( 'yith_get_date_formats' ) ) {
/**
* Get all available date formats.
*
* @param bool $js JS date format or not.
*
* @return array
* @since 3.5
*/
function yith_get_date_formats( $js = true ) {
$date_formats = array(
'F j, Y' => 'F j, Y',
'Y-m-d' => 'Y-m-d',
'm/d/Y' => 'm/d/Y',
'd/m/Y' => 'd/m/Y',
);
if ( $js ) {
$date_formats = array(
'MM d, yy' => 'F j, Y',
'yy-mm-dd' => 'Y-m-d',
'mm/dd/yy' => 'm/d/Y',
'dd/mm/yy' => 'd/m/Y',
);
}
return apply_filters( 'yith_plugin_fw_date_formats', $date_formats, $js );
}
}
if ( ! function_exists( 'yith_get_time_formats' ) ) {
/**
* Get all available time format.
*
* @return array
* @author Emanuela Castorina
* @since 3.5
*/
function yith_get_time_formats() {
$time_formats = array(
'h:i:s' => 'h:i:s',
'g:i a' => 'g:i a',
'g:i A' => 'g:i A',
'H:i' => 'H:i',
);
return apply_filters( 'yith_plugin_fw_time_formats', $time_formats );
}
}
if ( ! function_exists( 'yith_format_toggle_title' ) ) {
/**
* Replace the placeholders with the values of the element id for toggle element field.
*
* @param string $title The title.
* @param array $values The values.
*
* @return array
* @author Salvatore Strano
* @since 3.1
*/
function yith_format_toggle_title( $title, $values ) {
preg_match_all( '/(?<=\%%).+?(?=\%%)/', $title, $matches );
if ( isset( $matches[0] ) ) {
foreach ( $matches[0] as $element_id ) {
if ( isset( $values[ $element_id ] ) ) {
$title = str_replace( '%%' . $element_id . '%%', $values[ $element_id ], $title );
}
}
}
return $title;
}
}
if ( ! function_exists( 'yith_plugin_fw_load_update_and_licence_files' ) ) {
/**
* Load premium file for license and update system
*
* @author Andrea Grillo
*/
function yith_plugin_fw_load_update_and_licence_files() {
global $plugin_upgrade_fw_data;
/**
* If the init.php was load by old plugin-fw version
* load the upgrade and license key from local folder
*/
if ( empty( $plugin_upgrade_fw_data ) ) {
$plugin_upgrade_path = plugin_dir_path( __DIR__ ) . 'plugin-upgrade';
if ( file_exists( $plugin_upgrade_path ) ) {
$required_files = array(
$plugin_upgrade_path . '/lib/yit-licence.php',
$plugin_upgrade_path . '/lib/yit-plugin-licence.php',
$plugin_upgrade_path . '/lib/yit-theme-licence.php',
$plugin_upgrade_path . '/lib/yit-plugin-upgrade.php',
);
$plugin_upgrade_fw_data = array( '1.0' => $required_files );
}
}
if ( ! empty( $plugin_upgrade_fw_data ) && is_array( $plugin_upgrade_fw_data ) ) {
foreach ( $plugin_upgrade_fw_data as $fw_version => $core_files ) {
foreach ( $core_files as $core_file ) {
if ( file_exists( $core_file ) ) {
include_once $core_file;
}
}
}
}
}
}
if ( ! function_exists( 'yith_plugin_fw_remove_duplicate_classes' ) ) {
/**
* Remove the duplicate classes from a string.
*
* @param string $classes The classes.
*
* @return string
* @since 3.2.2
* @author Emanuela Castorina
*/
function yith_plugin_fw_remove_duplicate_classes( $classes ) {
$class_array = explode( ' ', $classes );
$class_unique = array_unique( array_filter( $class_array ) );
if ( $class_unique ) {
$classes = implode( ' ', $class_unique );
}
return $classes;
}
}
if ( ! function_exists( 'yith_plugin_fw_add_requirements' ) ) {
/**
* Add plugin requirements
*
* @param string $plugin_name The name of the plugin.
* @param array $requirements Array of plugin requirements.
*/
function yith_plugin_fw_add_requirements( $plugin_name, $requirements ) {
if ( ! empty( $requirements ) ) {
YITH_System_Status()->add_requirements( $plugin_name, $requirements );
}
}
}
if ( ! function_exists( 'yith_plugin_fw_parse_dimensions' ) ) {
/**
* Parse dimensions stored through a "dimensions" field to a key-value array
* where the key will be equal to the dimension key
* and the value will be equal to the value of the dimension suffixed with the unit
*
* @param array $values The values.
*
* @return array
*/
function yith_plugin_fw_parse_dimensions( $values ) {
$dimensions = array();
if ( is_array( $values ) && isset( $values['dimensions'], $values['unit'] ) && is_array( $values['dimensions'] ) ) {
$raw_unit = $values['unit'];
$unit = 'percentage' === $raw_unit ? '%' : $raw_unit;
foreach ( $values['dimensions'] as $key => $value ) {
$dimensions[ $key ] = $value . $unit;
}
}
return $dimensions;
}
}
if ( ! function_exists( 'yith_plugin_fw_get_dimensions_by_option' ) ) {
/**
* Retrieve a parsed array of dimensions by an option
*
* @param string $option The option.
* @param bool|array $default Default value.
*
* @return array|bool
*/
function yith_plugin_fw_get_dimensions_by_option( $option, $default = false ) {
$dimensions = get_option( $option, false );
return ! ! $dimensions ? yith_plugin_fw_parse_dimensions( $dimensions ) : $default;
}
}
if ( ! function_exists( 'yith_plugin_fw_extract' ) ) {
/**
* Extract array variables
*
* Usage example:
* ```
* list ( $type, $class, $value ) = yith_plugin_fw_extract( $field, 'type', 'class', 'value' );
* ```
*
* @param array $array The array.
* @param string ...$keys The keys.
*
* @return array
* @since 3.5
*/
function yith_plugin_fw_extract( $array, ...$keys ) {
return array_map(
function ( $key ) use ( $array ) {
return isset( $array[ $key ] ) ? $array[ $key ] : null;
},
$keys
);
}
}