WooCommerce Code Reference

Search results

Abstract_WC_Order_Data_Store_CPT extends WC_Data_Store_WP implements WC_Object_Data_Store_Interface, WC_Abstract_Order_Data_Store_Interface

Abstract Order Data Store: Stored in CPT.

Table of Contents

$meta_type Internal meta type used to store order data. string
$internal_meta_keys Data stored in meta keys, but not considered "meta" for an order. array
$meta_type Meta type. This should match up with the types available at https://developer.wordpress.org/reference/functions/add_metadata/. string
$object_id_field_for_meta This only needs set if you are using a custom metadata type (for example payment tokens. string
$internal_meta_keys Data stored in meta keys, but not considered "meta" for an object. array
$must_exist_meta_keys Meta data which should exist in the DB, even if empty. array
create() Method to create a new order in the database. mixed
read() Method to read an order from the database. mixed
update() Method to update an order in the database. mixed
delete() Method to delete an order from the database. void
get_post_status() Get the status to save to the post object. string
get_post_excerpt() Excerpt for post. string
get_post_title() Get a title for the new post type. string
get_order_key() Get order key. string
read_order_data() Read order data. Can be overridden by child classes to load other props. mixed
update_post_meta() Helper method that updates all the post meta for an order based on it's settings in the WC_Order class. mixed
clear_caches() Clear any caches. mixed
read_items() Read order items of a specific type from the database for this order. array
delete_items() Remove all line items (products, coupons, shipping, taxes) from the order. mixed
get_payment_token_ids() Get token ids for an order. array
update_payment_token_ids() Update token ids for an order. mixed
get_term_ids() Get and store terms from a taxonomy. array
read_meta() Returns an array of meta for an object. array
delete_meta() Deletes meta based on meta ID. mixed
add_meta() Add new piece of meta. int
update_meta() Update meta. mixed
get_db_info() Table structure is slightly different between meta types, this function will return what we need to know. array
prefix_key() Internal meta keys we don't want exposed as part of meta_data. This is in addition to all data props with _ prefix. string
exclude_internal_meta_keys() Callback to remove unwanted meta data. bool
get_props_to_update() Gets a list of props and meta keys that need updated based on change state or if they are present in the database or not. array
update_or_delete_post_meta() Update meta data in, or delete it from, the database. bool
get_wp_query_args() Get valid WP_Query args from a WC_Object_Query's query variables. array
parse_date_for_wp_query() Map a valid date query var to WP_Query arguments. array
get_internal_meta_keys() Return list of internal meta keys. array
get_valid_search_terms() Check if the terms are suitable for searching. array
get_search_stopwords() Retrieve stopwords used when parsing search terms. array
get_data_for_lookup_table() Get data to save to a lookup table. array
get_primary_key_for_lookup_table() Get primary key name for lookup table. string
update_lookup_table() Update a lookup table for an object. null
delete_from_lookup_table() Delete lookup table data for an ID. mixed

Properties

$meta_type

Internal meta type used to store order data.

protected string $meta_type = 'post'
WP defines 'post', 'user', 'comment', and 'term'.

$internal_meta_keys

Data stored in meta keys, but not considered "meta" for an order.

protected array $internal_meta_keys = array('_order_currency', '_cart_discount', '_cart_discount_tax', '_order_shipping', '_order_shipping_tax', '_order_tax', '_order_total', '_order_version', '_prices_include_tax', '_payment_tokens')

$meta_type

Meta type. This should match up with the types available at https://developer.wordpress.org/reference/functions/add_metadata/.

protected string $meta_type = 'post'
WP defines 'post', 'user', 'comment', and 'term'.

$object_id_field_for_meta

This only needs set if you are using a custom metadata type (for example payment tokens.

protected string $object_id_field_for_meta = ''
This should be the name of the field your table uses for associating meta with objects. For example, in payment_tokenmeta, this would be payment_token_id.

$internal_meta_keys

Data stored in meta keys, but not considered "meta" for an object.

protected array $internal_meta_keys = array()

$must_exist_meta_keys

Meta data which should exist in the DB, even if empty.

protected array $must_exist_meta_keys = array()

Methods

delete()

Method to delete an order from the database.

public delete( &$order : WC_Order [, $args : array = array() ] ) : void
Parameters
$order : WC_Order

Order object.

$args : array = array()

Array of args to pass to the delete method.

get_post_status()

Get the status to save to the post object.

protected get_post_status( $order : WC_order ) : string

Plugins extending the order classes can override this to change the stored status/add prefixes etc.

Parameters
$order : WC_order

Order object.

Tags
since
Return values
string

get_post_excerpt()

Excerpt for post.

protected get_post_excerpt( $order : WC_order ) : string
Parameters
$order : WC_order

Order object.

Return values
string

get_order_key()

Get order key.

protected get_order_key( $order : WC_order ) : string
Parameters
$order : WC_order

Order object.

Tags
since
Return values
string

read_order_data()

Read order data. Can be overridden by child classes to load other props.

protected read_order_data( &$order : WC_Order , $post_object : object ) : mixed
Parameters
$order : WC_Order

Order object.

$post_object : object

Post object.

Tags
since
Return values
mixed

update_post_meta()

Helper method that updates all the post meta for an order based on it's settings in the WC_Order class.

protected update_post_meta( &$order : WC_Order ) : mixed
Parameters
$order : WC_Order

Order object.

Tags
since
Return values
mixed

read_items()

Read order items of a specific type from the database for this order.

public read_items( $order : WC_Order , $type : string ) : array
Parameters
$order : WC_Order

Order object.

$type : string

Order item type.

Return values
array

delete_items()

Remove all line items (products, coupons, shipping, taxes) from the order.

public delete_items( $order : WC_Order [, $type : string = null ] ) : mixed
Parameters
$order : WC_Order

Order object.

$type : string = null

Order item type. Default null.

Return values
mixed

update_payment_token_ids()

Update token ids for an order.

public update_payment_token_ids( $order : WC_Order , $token_ids : array ) : mixed
Parameters
$order : WC_Order

Order object.

$token_ids : array

Payment token ids.

Return values
mixed

get_term_ids()

Get and store terms from a taxonomy.

protected get_term_ids( $object : WC_Data|int , $taxonomy : string ) : array
Parameters
$object : WC_Data|int

WC_Data object or object ID.

$taxonomy : string

Taxonomy name e.g. product_cat.

Tags
since
Return values
array

of terms

read_meta()

Returns an array of meta for an object.

public read_meta( &$object : WC_Data ) : array
Parameters
$object : WC_Data

WC_Data object.

Tags
since
Return values
array

delete_meta()

Deletes meta based on meta ID.

public delete_meta( &$object : WC_Data , $meta : stdClass ) : mixed
Parameters
$object : WC_Data

WC_Data object.

$meta : stdClass

(containing at least ->id).

Tags
since
Return values
mixed

add_meta()

Add new piece of meta.

public add_meta( &$object : WC_Data , $meta : stdClass ) : int
Parameters
$object : WC_Data

WC_Data object.

$meta : stdClass

(containing ->key and ->value).

Tags
since
Return values
int

meta ID

update_meta()

Update meta.

public update_meta( &$object : WC_Data , $meta : stdClass ) : mixed
Parameters
$object : WC_Data

WC_Data object.

$meta : stdClass

(containing ->id, ->key and ->value).

Tags
since
Return values
mixed

get_db_info()

Table structure is slightly different between meta types, this function will return what we need to know.

protected get_db_info( ) : array
Tags
since
Return values
array

Array elements: table, object_id_field, meta_id_field

prefix_key()

Internal meta keys we don't want exposed as part of meta_data. This is in addition to all data props with _ prefix.

protected prefix_key( $key : string ) : string
Parameters
$key : string

Prefix to be added to meta keys.

Tags
since
Return values
string

exclude_internal_meta_keys()

Callback to remove unwanted meta data.

protected exclude_internal_meta_keys( $meta : object ) : bool
Parameters
$meta : object

Meta object to check if it should be excluded or not.

Return values
bool

get_props_to_update()

Gets a list of props and meta keys that need updated based on change state or if they are present in the database or not.

protected get_props_to_update( $object : WC_Data , $meta_key_to_props : array [, $meta_type : string = 'post' ] ) : array
Parameters
$object : WC_Data

The WP_Data object (WC_Coupon for coupons, etc).

$meta_key_to_props : array

A mapping of meta keys => prop names.

$meta_type : string = 'post'

The internal WP meta type (post, user, etc).

Return values
array

A mapping of meta keys => prop names, filtered by ones that should be updated.

update_or_delete_post_meta()

Update meta data in, or delete it from, the database.

protected update_or_delete_post_meta( $object : WC_Data , $meta_key : string , $meta_value : mixed ) : bool

Avoids storing meta when it's either an empty string or empty array. Other empty values such as numeric 0 and null should still be stored. Data-stores can force meta to exist using must_exist_meta_keys.

Note: WordPress get_metadata function returns an empty string when meta data does not exist.

Parameters
$object : WC_Data

The WP_Data object (WC_Coupon for coupons, etc).

$meta_key : string

Meta key to update.

$meta_value : mixed

Value to save.

Tags
since

Added to prevent empty meta being stored unless required.

Return values
bool

True if updated/deleted.

get_wp_query_args()

Get valid WP_Query args from a WC_Object_Query's query variables.

protected get_wp_query_args( $query_vars : array ) : array
Parameters
$query_vars : array

query vars from a WC_Object_Query.

Tags
since
Return values
array

parse_date_for_wp_query()

Map a valid date query var to WP_Query arguments.

public parse_date_for_wp_query( $query_var : mixed , $key : string [, $wp_query_args : array = array() ] ) : array

Valid date formats: YYYY-MM-DD or timestamp, possibly combined with an operator from $valid_operators. Also accepts a WC_DateTime object.

Parameters
$query_var : mixed

A valid date format.

$key : string

meta or db column key.

$wp_query_args : array = array()

WP_Query args.

Tags
since
Return values
array

Modified $wp_query_args

get_internal_meta_keys()

Return list of internal meta keys.

public get_internal_meta_keys( ) : array
Tags
since
Return values
array

get_valid_search_terms()

Check if the terms are suitable for searching.

protected get_valid_search_terms( $terms : array ) : array

Uses an array of stopwords (terms) that are excluded from the separate term matching when searching for posts. The list of English stopwords is the approximate search engines list, and is translatable.

Parameters
$terms : array

Terms to check.

Tags
since
Return values
array

Terms that are not stopwords.

get_search_stopwords()

Retrieve stopwords used when parsing search terms.

protected get_search_stopwords( ) : array
Tags
since
Return values
array

Stopwords.

get_data_for_lookup_table()

Get data to save to a lookup table.

protected get_data_for_lookup_table( $id : int , $table : string ) : array
Parameters
$id : int

ID of object to update.

$table : string

Lookup table name.

Tags
since
Return values
array

get_primary_key_for_lookup_table()

Get primary key name for lookup table.

protected get_primary_key_for_lookup_table( $table : string ) : string
Parameters
$table : string

Lookup table name.

Tags
since
Return values
string

update_lookup_table()

Update a lookup table for an object.

protected update_lookup_table( $id : int , $table : string ) : null
Parameters
$id : int

ID of object to update.

$table : string

Lookup table name.

Tags
since
Return values
null

delete_from_lookup_table()

Delete lookup table data for an ID.

public delete_from_lookup_table( $id : int , $table : string ) : mixed
Parameters
$id : int

ID of object to update.

$table : string

Lookup table name.

Tags
since
Return values
mixed
Back to the top