value pairs to customise the input fields
* 'id_attr': (string) the date to display in the selector in MySQL format ('Y-m-d H:i:s'). Required.
* 'date': (string) the date to display in the selector in MySQL format ('Y-m-d H:i:s'). Required.
* 'tab_index': (int) the tab index for the element. Optional. Default 0.
* 'include_time': (bool) whether to include a specific time for the selector. Default true.
* 'include_year': (bool) whether to include a the year field. Default true.
* 'include_buttons': (bool) whether to include submit buttons on the selector. Default true.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
function wcs_date_input( $timestamp = 0, $args = array() ) {
$args = wp_parse_args(
$args,
array(
'name_attr' => '',
'include_time' => true,
)
);
$date = ( 0 !== $timestamp ) ? date_i18n( 'Y-m-d', $timestamp ) : '';
// translators: date placeholder for input, javascript format
$date_input = '';
if ( true === $args['include_time'] ) {
$hours = ( 0 !== $timestamp ) ? date_i18n( 'H', $timestamp ) : '';
// translators: hour placeholder for time input, javascript format
$hour_input = '';
$minutes = ( 0 !== $timestamp ) ? date_i18n( 'i', $timestamp ) : '';
// translators: minute placeholder for time input, javascript format
$minute_input = '';
$date_input = sprintf( '%s@%s:%s', $date_input, $hour_input, $minute_input );
}
$timestamp_utc = ( 0 !== $timestamp ) ? $timestamp - get_option( 'gmt_offset', 0 ) * HOUR_IN_SECONDS : $timestamp;
$date_input = '
' . $date_input . '
';
return apply_filters( 'woocommerce_subscriptions_date_input', $date_input, $timestamp, $args );
}
/**
* Get the admin edit link for an order.
*
* Note: this function does not check if the user has permission to edit the order.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
* @since 7.4.0 - Added official support for WC_Order objects as the first parameter.
*
* @param int|WC_Order $order The order ID or WC_Order object.
* @return string The edit order URL or an empty string if the order is not found or is not a valid order type.
*/
function wcs_get_edit_post_link( $order ) {
$order = is_a( $order, 'WC_Abstract_Order' ) ? $order : wc_get_order( $order );
if ( ! $order || ! in_array( $order->get_type(), array( 'shop_order', 'shop_subscription' ), true ) ) {
return '';
}
return apply_filters( 'get_edit_post_link', $order->get_edit_order_url(), $order->get_id(), '' );
}
/**
* Returns a string with all non-ASCII characters removed. This is useful for any string functions that expect only
* ASCII chars and can't safely handle UTF-8
*
* Based on the SV_WC_Helper::str_to_ascii() method developed by the masterful SkyVerge team
*
* Note: We must do a strict false check on the iconv() output due to a bug in PHP/glibc {@link https://bugs.php.net/bug.php?id=63450}
*
* @param string $string string to make ASCII
* @return string|null ASCII string or null if error occurred
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
function wcs_str_to_ascii( $string ) {
$ascii = false;
if ( function_exists( 'iconv' ) ) {
$ascii = iconv( 'UTF-8', 'ASCII//IGNORE', $string );
}
return false === $ascii ? preg_replace( '/[^a-zA-Z0-9_\-]/', '', $string ) : $ascii;
}
/**
* wp_json_encode exists since WP 4.1, but because we can't be sure that stores will actually use at least 4.1, we need
* to have this wrapper.
*
* @param array $data Data to be encoded
*
* @return string
*/
function wcs_json_encode( $data ) {
if ( function_exists( 'wp_json_encode' ) ) {
return wp_json_encode( $data );
}
return json_encode( $data );
}
/**
* Inserts a new key/value after the key in the array.
*
* @param $needle The array key to insert the element after
* @param $haystack An array to insert the element into
* @param $new_key The key to insert
* @param $new_value An value to insert
* @return array The new array if the $needle key exists, otherwise an unmodified $haystack
*/
function wcs_array_insert_after( $needle, $haystack, $new_key, $new_value ) {
if ( array_key_exists( $needle, $haystack ) ) {
$new_array = array();
foreach ( $haystack as $key => $value ) {
$new_array[ $key ] = $value;
if ( $key === $needle ) {
$new_array[ $new_key ] = $new_value;
}
}
return $new_array;
}
return $haystack;
}
/**
* Helper function to get around WooCommerce version 2.6.3 which removed the constant WC_ROUNDING_PRECISION and
* introduced the function wc_get_rounding_precision. Every version 2.6.2 and earlier has the constant. Every version
* 2.6.4 and later (hopefully) will also have the constant AND the wc_get_rounding_precision function. 2.6.3 only has
* the function however.
*
* @see https://github.com/Prospress/woocommerce-subscriptions/issues/1545
*
* @return int rounding precision
*/
function wcs_get_rounding_precision() {
if ( function_exists( 'wc_get_rounding_precision' ) ) {
$precision = wc_get_rounding_precision();
} elseif ( defined( 'WC_ROUNDING_PRECISION' ) ) {
$precision = WC_ROUNDING_PRECISION;
} else {
$precision = wc_get_price_decimals() + 2;
}
return $precision;
}
/**
* Add a prefix to a string or array of strings if it doesn't already have it
*
* @param string|array $key The key or array of keys to add the prefix to.
* @param string $prefix The prefix to add.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.0
*
* @return string|array The key or array of keys with the prefix added.
*/
function wcs_maybe_prefix_key( $key, $prefix = '_' ) {
if ( is_array( $key ) ) {
return array_map( __FUNCTION__, $key, array_fill( 0, count( $key ), $prefix ) );
}
return ( substr( $key, 0, strlen( $prefix ) ) !== $prefix ) ? $prefix . $key : $key;
}
/**
* Remove a prefix from a string or array of strings if it has it.
*
* @param string|array $key The key or array of keys to remove the prefix from.
* @param string $prefix The prefix to remove.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.0
*
* @return string|array The key or array of keys with the prefix removed.
*/
function wcs_maybe_unprefix_key( $key, $prefix = '_' ) {
if ( is_array( $key ) ) {
return array_map( __FUNCTION__, $key, array_fill( 0, count( $key ), $prefix ) );
}
return ( substr( $key, 0, strlen( $prefix ) ) === $prefix ) ? substr( $key, strlen( $prefix ) ) : $key;
}
/**
* Find the name of the function which called the function which called this function.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.0
* @return string
*/
function wcs_get_calling_function_name() {
$backtrace = version_compare( phpversion(), '5.4.0', '>=' ) ? debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS, 3 ) : debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // the 2nd param for debug_backtrace() was added in PHP 5.4
$calling_function = isset( $backtrace[2]['class'] ) ? $backtrace[2]['class'] : '';
$calling_function .= isset( $backtrace[2]['type'] ) ? ( ( '->' == $backtrace[2]['type'] ) ? '::' : $backtrace[2]['type'] ) : ''; // Ternary abuses
$calling_function .= isset( $backtrace[2]['function'] ) ? $backtrace[2]['function'] : '';
return $calling_function;
}
/**
* Get the value of a transient, even if it has expired.
*
* Handy when data cached in a transient will be valid even if the transient has expired.
*
* @param string $transient_key The key used to set/get the transient via get_transient()/set_transient()
* @return mixed If data exists in a transient, the value of the transient, else boolean false.
*/
function wcs_get_transient_even_if_expired( $transient_key ) {
wcs_deprecated_function( __FUNCTION__, '2.3.3' );
// First, check if the transient exists via the Options API to access the value in the database without WordPress checking the transient's expiration time (and returning false if it's < now)
$transient_value = get_option( sprintf( '_transient_%s', $transient_key ) );
if ( false === $transient_value ) {
$transient_value = get_transient( $transient_key );
}
return $transient_value;
}
/**
* Get a minor version string from a full version string.
*
* @param string $version Version string (eg 1.0.1).
* @return string The minor release version string (eg 1.0).
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.3.0
*/
function wcs_get_minor_version_string( $version ) {
$version_parts = array_pad( array_map( 'intval', explode( '.', $version ) ), 2, 0 );
return $version_parts[0] . '.' . $version_parts[1];
}
/**
* Determines if the current request is for the frontend.
*
* The logic in this function is based off WooCommerce::is_request( 'frontend' ).
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.7
*
* @return bool True if it's a frontend request, false otherwise.
*/
function wcs_is_frontend_request() {
return ( ! is_admin() || wcs_doing_ajax() ) && ! wcs_doing_cron() && ! wcs_is_rest_api_request();
}
/**
* Sorts an array of objects by a given property in a given order.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.0
*
* @param array $objects An array of objects to sort.
* @param string $property The property to sort by.
* @param string $sort_order Optional. The order to sort by. Must be 'ascending' or 'descending'. Default is 'ascending'.
*
* @throws InvalidArgumentException Thrown if an invalid sort order is given.
* @return array The array of objects sorted.
*/
function wcs_sort_objects( &$objects, $property, $sort_order = 'ascending' ) {
if ( 'ascending' !== $sort_order && 'descending' !== $sort_order ) {
// translators: 1) passed sort order type argument, 2) 'ascending', 3) 'descending'.
throw new InvalidArgumentException( sprintf( __( 'Invalid sort order type: %1$s. The $sort_order argument must be %2$s or %3$s.', 'woocommerce-subscriptions' ), $sort_order, '"descending"', '"ascending"' ) );
}
uasort( $objects, array( new WCS_Object_Sorter( $property ), "{$sort_order}_compare" ) );
return $objects;
}
/**
* Has the trial for the Subscription passed? If the Subscription is invalid, will return a WP_Error
*
* @param int|WC_Subscription $subscription
*
* @return bool|WP_Error
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.6
*/
function wcs_trial_has_passed( $subscription ) {
$subscription = wcs_get_subscription( $subscription );
if ( $subscription ) {
return apply_filters( 'woocommerce_subscription_trial_has_passed', $subscription->get_time( 'trial_end' ) > 0 && $subscription->get_time( 'trial_end' ) < gmdate( 'U' ), $subscription );
} else {
return new WP_Error( 'woocommerce_subscription_invalid_subscription', __( 'Invalid Subscription.', 'woocommerce-subscriptions' ) );
}
}
/**
* Filters an array using a WP filter.
*
* This function behaves similar to PHP's array_filter(), except instead of a callback it uses a filter.
* This allows third-parties via WP filter callbacks to filter the array.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.1.0
*
* @param string $filter The WP filter to apply to each element.
* @param array $array The array of items to check.
* @param array $property The name of object's property to check. Optional. Default is '' - the array element value as a boolean will be used, the same as array_filter().
*/
function wcs_apply_array_filter( $filter, $array, $property = array() ) {
foreach ( $array as $index => $element ) {
$value = empty( $property ) ? $element : $element->{$property};
if ( ! apply_filters( $filter, (bool) $value, $element, $property, $array ) ) {
unset( $array[ $index ] );
}
}
return $array;
}
/**
* Compares an order's billing address and shipping address and returns true if they are the same.
*
* @since 5.3.0
*
* @see woocommerce_ship_to_different_address_checked
*
* @param WC_Order $order
* @return bool True if the order's billing address and shipping address are the same, false otherwise.
*/
function wcs_compare_order_billing_shipping_address( $order ) {
$billing_address = $order->get_address( 'billing' );
$shipping_address = $order->get_address( 'shipping' );
// Remove extraneous fields from each address when comparing
if ( isset( $billing_address['email'] ) ) {
unset( $billing_address['email'] );
}
if ( isset( $billing_address['phone'] ) ) {
unset( $billing_address['phone'] );
}
if ( isset( $shipping_address['email'] ) ) {
unset( $shipping_address['email'] );
}
if ( isset( $shipping_address['phone'] ) ) {
unset( $shipping_address['phone'] );
}
// Compare the two addresses using array equality operator.
// phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison -- using `==` is suitable here to ignore the order of array keys.
$addresses_are_equal = $shipping_address == $billing_address;
return $addresses_are_equal;
}