ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / caimegroup.com / wp-content / plugins / woocommerce / includes

<?php
/**
 * WooCommerce Order Item Functions
 *
 * Functions for order specific things.
 *
 * @package WooCommerce\Functions
 * @version 3.4.0
 */

defined( 'ABSPATH' ) || exit;

/**
 * Add a item to an order (for example a line item).
 *
 * @param int   $order_id   Order ID.
 * @param array $item_array Items list.
 *
 * @throws Exception        When `WC_Data_Store::load` validation fails.
 * @return int|bool         Item ID or false
 */
function wc_add_order_item( $order_id, $item_array ) {
	$order_id = absint( $order_id );

if ( ! $order_id ) {
		return false;
	}

$defaults = array(
		'order_item_name' => '',
		'order_item_type' => 'line_item',
	);

$item_array = wp_parse_args( $item_array, $defaults );
	$data_store = WC_Data_Store::load( 'order-item' );
	$item_id    = $data_store->add_order_item( $order_id, $item_array );
	$item       = WC_Order_Factory::get_order_item( $item_id );

do_action( 'woocommerce_new_order_item', $item_id, $item, $order_id );

return $item_id;
}

/**
 * Update an item for an order.
 *
 * @since 2.2
 * @param int   $item_id Item ID.
 * @param array $args    Either `order_item_type` or `order_item_name`.
 *
 * @throws Exception     When `WC_Data_Store::load` validation fails.
 * @return bool          True if successfully updated, false otherwise.
 */
function wc_update_order_item( $item_id, $args ) {
	$data_store = WC_Data_Store::load( 'order-item' );
	$update     = $data_store->update_order_item( $item_id, $args );

if ( false === $update ) {
		return false;
	}

do_action( 'woocommerce_update_order_item', $item_id, $args );

return true;
}

/**
 * Delete an item from the order it belongs to based on item id.
 *
 * @param int $item_id  Item ID.
 *
 * @throws Exception    When `WC_Data_Store::load` validation fails.
 * @return bool
 */
function wc_delete_order_item( $item_id ) {
	$item_id = absint( $item_id );

if ( ! $item_id ) {
		return false;
	}

$data_store = WC_Data_Store::load( 'order-item' );

do_action( 'woocommerce_before_delete_order_item', $item_id );

$data_store->delete_order_item( $item_id );

do_action( 'woocommerce_delete_order_item', $item_id );

return true;
}

/**
 * WooCommerce Order Item Meta API - Update term meta.
 *
 * @param int    $item_id    Item ID.
 * @param string $meta_key   Meta key.
 * @param mixed  $meta_value Meta value.
 * @param string $prev_value Previous value (default: '').
 *
 * @throws Exception         When `WC_Data_Store::load` validation fails.
 * @return bool
 */
function wc_update_order_item_meta( $item_id, $meta_key, $meta_value, $prev_value = '' ) {
	$data_store = WC_Data_Store::load( 'order-item' );
	if ( $data_store->update_metadata( $item_id, $meta_key, $meta_value, $prev_value ) ) {
		WC_Cache_Helper::invalidate_cache_group( 'object_' . $item_id ); // Invalidate cache.
		return true;
	}
	return false;
}

/**
 * WooCommerce Order Item Meta API - Add term meta.
 *
 * @param int    $item_id    Item ID.
 * @param string $meta_key   Meta key.
 * @param mixed  $meta_value Meta value.
 * @param bool   $unique     If meta data should be unique (default: false).
 *
 * @throws Exception         When `WC_Data_Store::load` validation fails.
 * @return int               New row ID or 0.
 */
function wc_add_order_item_meta( $item_id, $meta_key, $meta_value, $unique = false ) {
	$data_store = WC_Data_Store::load( 'order-item' );
	$meta_id    = $data_store->add_metadata( $item_id, $meta_key, $meta_value, $unique );

if ( $meta_id ) {
		WC_Cache_Helper::invalidate_cache_group( 'object_' . $item_id ); // Invalidate cache.
		return $meta_id;
	}
	return 0;
}

/**
 * WooCommerce Order Item Meta API - Delete term meta.
 *
 * @param int    $item_id    Item ID.
 * @param string $meta_key   Meta key.
 * @param mixed  $meta_value Meta value (default: '').
 * @param bool   $delete_all Delete all meta data, defaults to `false`.
 *
 * @throws Exception         When `WC_Data_Store::load` validation fails.
 * @return bool
 */
function wc_delete_order_item_meta( $item_id, $meta_key, $meta_value = '', $delete_all = false ) {
	$data_store = WC_Data_Store::load( 'order-item' );
	if ( $data_store->delete_metadata( $item_id, $meta_key, $meta_value, $delete_all ) ) {
		WC_Cache_Helper::invalidate_cache_group( 'object_' . $item_id ); // Invalidate cache.
		return true;
	}
	return false;
}

/**
 * WooCommerce Order Item Meta API - Get term meta.
 *
 * @param int    $item_id Item ID.
 * @param string $key     Meta key.
 * @param bool   $single  Whether to return a single value. (default: true).
 *
 * @throws Exception      When `WC_Data_Store::load` validation fails.
 * @return mixed
 */
function wc_get_order_item_meta( $item_id, $key, $single = true ) {
	$data_store = WC_Data_Store::load( 'order-item' );
	return $data_store->get_metadata( $item_id, $key, $single );
}

/**
 * Get order ID by order item ID.
 *
 * @param  int $item_id Item ID.
 *
 * @throws Exception    When `WC_Data_Store::load` validation fails.
 * @return int
 */
function wc_get_order_id_by_order_item_id( $item_id ) {
	$data_store = WC_Data_Store::load( 'order-item' );
	return $data_store->get_order_id_by_order_item_id( $item_id );
}

[+] ..
[-] wc-page-functions.php [edit]
[-] class-wc-countries.php [edit]
[-] class-wc-ajax.php [edit]
[-] class-wc-privacy.php [edit]
[+] customizer
[+] gateways
[-] class-wc-order-refund.php [edit]
[-] wc-stock-functions.php [edit]
[-] class-wc-cart.php [edit]
[-] class-wc-tracker.php [edit]
[-] class-wc-frontend-scripts.php [edit]
[-] class-wc-product-download.php [edit]
[+] widgets
[+] admin
[-] class-wc-auth.php [edit]
[-] class-wc-rest-authentication.php [edit]
[-] class-wc-data-exception.php [edit]
[-] class-wc-log-levels.php [edit]
[-] wc-coupon-functions.php [edit]
[-] class-wc-order-item-shipping.php [edit]
[+] integrations
[-] class-wc-payment-gateways.php [edit]
[-] wc-order-functions.php [edit]
[+] shipping
[-] class-wc-order-item-coupon.php [edit]
[-] class-wc-payment-tokens.php [edit]
[-] wc-deprecated-functions.php [edit]
[-] class-wc-product-grouped.php [edit]
[+] tracks
[-] wc-product-functions.php [edit]
[-] class-wc-datetime.php [edit]
[-] wc-user-functions.php [edit]
[-] wc-widget-functions.php [edit]
[-] class-wc-breadcrumb.php [edit]
[-] class-wc-customer-download-log.php [edit]
[-] class-wc-order-query.php [edit]
[-] wc-template-hooks.php [edit]
[-] class-wc-https.php [edit]
[-] class-wc-order.php [edit]
[-] wc-attribute-functions.php [edit]
[-] class-wc-session-handler.php [edit]
[-] class-wc-product-variation.php [edit]
[-] class-wc-query.php [edit]
[-] class-wc-coupon.php [edit]
[-] class-wc-shipping-zone.php [edit]
[-] wc-account-functions.php [edit]
[-] wc-formatting-functions.php [edit]
[-] class-wc-integrations.php [edit]
[-] class-wc-validation.php [edit]
[-] class-wc-webhook.php [edit]
[+] traits
[-] class-wc-checkout.php [edit]
[-] wc-core-functions.php [edit]
[+] emails
[-] wc-cart-functions.php [edit]
[-] class-wc-shipping.php [edit]
[-] class-wc-customer-download.php [edit]
[-] class-wc-geolite-integration.php [edit]
[-] class-wc-data-store.php [edit]
[-] class-wc-order-item-tax.php [edit]
[-] class-wc-customer.php [edit]
[-] class-wc-product-attribute.php [edit]
[+] legacy
[+] import
[-] class-wc-cli.php [edit]
[+] wccom-site
[-] class-wc-form-handler.php [edit]
[-] class-wc-tax.php [edit]
[-] wc-order-item-functions.php [edit]
[+] blocks
[-] class-wc-cache-helper.php [edit]
[-] class-wc-cart-totals.php [edit]
[-] class-wc-emails.php [edit]
[-] class-wc-product-query.php [edit]
[-] class-wc-download-handler.php [edit]
[-] class-wc-product-external.php [edit]
[-] class-woocommerce.php [edit]
[-] class-wc-logger.php [edit]
[-] class-wc-shipping-zones.php [edit]
[-] class-wc-order-item-meta.php [edit]
[+] walkers
[+] shortcodes
[-] class-wc-cart-session.php [edit]
[+] rest-api
[-] class-wc-autoloader.php [edit]
[-] class-wc-meta-data.php [edit]
[-] wc-notice-functions.php [edit]
[+] queue
[+] react-admin
[-] class-wc-order-item.php [edit]
[-] class-wc-shortcodes.php [edit]
[-] wc-term-functions.php [edit]
[-] wc-webhook-functions.php [edit]
[-] class-wc-privacy-exporters.php [edit]
[-] class-wc-privacy-background-process.php [edit]
[-] class-wc-regenerate-images-request.php [edit]
[-] class-wc-deprecated-filter-hooks.php [edit]
[+] interfaces
[-] class-wc-background-emailer.php [edit]
[-] class-wc-geo-ip.php [edit]
[+] data-stores
[-] class-wc-comments.php [edit]
[-] wc-conditional-functions.php [edit]
[-] class-wc-product-factory.php [edit]
[+] theme-support
[+] libraries
[-] class-wc-structured-data.php [edit]
[-] class-wc-order-factory.php [edit]
[-] class-wc-cart-fees.php [edit]
[-] class-wc-deprecated-action-hooks.php [edit]
[-] class-wc-order-item-fee.php [edit]
[+] cli
[-] class-wc-background-updater.php [edit]
[-] class-wc-discounts.php [edit]
[-] class-wc-rate-limiter.php [edit]
[-] class-wc-geolocation.php [edit]
[-] class-wc-privacy-erasers.php [edit]
[-] class-wc-post-types.php [edit]
[+] export
[+] log-handlers
[-] class-wc-regenerate-images.php [edit]
[+] abstracts
[-] class-wc-rest-exception.php [edit]
[-] class-wc-order-item-product.php [edit]
[-] class-wc-product-simple.php [edit]
[-] wc-rest-functions.php [edit]
[-] class-wc-post-data.php [edit]
[-] class-wc-embed.php [edit]
[+] payment-tokens
[-] class-wc-template-loader.php [edit]
[-] class-wc-product-variable.php [edit]
[-] class-wc-install.php [edit]
[-] class-wc-shipping-rate.php [edit]
[-] class-wc-api.php [edit]
[-] wc-template-functions.php [edit]
[-] wc-update-functions.php [edit]
[-] class-wc-register-wp-admin-settings.php [edit]