2013-07-24 16:01:36 +00:00
< ? php
/**
2015-11-03 13:53:50 +00:00
* WooCommerce Admin Functions
2013-07-24 16:01:36 +00:00
*
2015-06-16 16:08:30 +00:00
* @ author WooThemes
* @ category Core
* @ package WooCommerce / Admin / Functions
* @ version 2.4 . 0
2013-07-24 16:01:36 +00:00
*/
2014-09-20 19:52:30 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
exit ; // Exit if accessed directly
}
2013-07-24 16:01:36 +00:00
/**
2015-11-03 13:31:20 +00:00
* Get all WooCommerce screen ids .
2013-07-24 16:01:36 +00:00
*
* @ return array
*/
2013-07-25 15:29:25 +00:00
function wc_get_screen_ids () {
2014-11-30 06:52:32 +00:00
2014-02-14 10:57:48 +00:00
$wc_screen_id = sanitize_title ( __ ( 'WooCommerce' , 'woocommerce' ) );
2014-07-20 23:53:43 +00:00
$screen_ids = array (
'toplevel_page_' . $wc_screen_id ,
$wc_screen_id . '_page_wc-reports' ,
2015-12-08 12:45:18 +00:00
$wc_screen_id . '_page_wc-shipping' ,
2014-07-20 23:53:43 +00:00
$wc_screen_id . '_page_wc-settings' ,
$wc_screen_id . '_page_wc-status' ,
$wc_screen_id . '_page_wc-addons' ,
2015-02-24 12:29:03 +00:00
'toplevel_page_wc-reports' ,
2014-07-20 23:53:43 +00:00
'product_page_product_attributes' ,
'edit-product' ,
'product' ,
'edit-shop_coupon' ,
'shop_coupon' ,
'edit-product_cat' ,
'edit-product_tag' ,
2015-02-15 20:36:18 +00:00
'profile' ,
2016-08-27 02:08:49 +00:00
'user-edit' ,
2014-07-20 23:53:43 +00:00
);
foreach ( wc_get_order_types () as $type ) {
$screen_ids [] = $type ;
$screen_ids [] = 'edit-' . $type ;
}
2017-05-18 14:22:12 +00:00
if ( $attributes = wc_get_attribute_taxonomies () ) {
foreach ( $attributes as $attribute ) {
$screen_ids [] = 'edit-' . wc_attribute_taxonomy_name ( $attribute -> attribute_name );
}
}
2014-07-20 23:53:43 +00:00
return apply_filters ( 'woocommerce_screen_ids' , $screen_ids );
2013-07-25 15:29:25 +00:00
}
/**
* Create a page and store the ID in an option .
*
* @ param mixed $slug Slug for the new page
2014-09-07 23:37:55 +00:00
* @ param string $option Option name to store the page ' s ID
2013-07-25 15:29:25 +00:00
* @ param string $page_title ( default : '' ) Title for the new page
* @ param string $page_content ( default : '' ) Content for the new page
* @ param int $post_parent ( default : 0 ) Parent for the new page
* @ return int page ID
*/
function wc_create_page ( $slug , $option = '' , $page_title = '' , $page_content = '' , $post_parent = 0 ) {
2014-07-20 23:53:43 +00:00
global $wpdb ;
2013-07-25 15:29:25 +00:00
2015-06-16 16:08:30 +00:00
$option_value = get_option ( $option );
2015-06-16 11:31:15 +00:00
2016-08-08 11:14:41 +00:00
if ( $option_value > 0 && ( $page_object = get_post ( $option_value ) ) ) {
2015-09-07 13:17:22 +00:00
if ( 'page' === $page_object -> post_type && ! in_array ( $page_object -> post_status , array ( 'pending' , 'trash' , 'future' , 'auto-draft' ) ) ) {
// Valid page is already in place
return $page_object -> ID ;
2015-06-16 11:31:15 +00:00
}
2014-09-22 18:30:07 +00:00
}
2015-06-16 16:08:30 +00:00
2014-07-20 23:53:43 +00:00
if ( strlen ( $page_content ) > 0 ) {
// Search for an existing page with the specified page content (typically a shortcode)
2015-09-07 13:17:22 +00:00
$valid_page_found = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status NOT IN ( 'pending', 'trash', 'future', 'auto-draft' ) AND post_content LIKE %s LIMIT 1; " , " % { $page_content } % " ) );
2014-07-20 23:53:43 +00:00
} else {
// Search for an existing page with the specified page slug
2015-09-07 13:17:22 +00:00
$valid_page_found = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status NOT IN ( 'pending', 'trash', 'future', 'auto-draft' ) AND post_name = %s LIMIT 1; " , $slug ) );
2014-07-20 23:53:43 +00:00
}
2013-07-25 15:29:25 +00:00
2015-09-07 13:17:22 +00:00
$valid_page_found = apply_filters ( 'woocommerce_create_page_id' , $valid_page_found , $slug , $page_content );
2015-06-16 11:31:15 +00:00
2015-09-07 13:17:22 +00:00
if ( $valid_page_found ) {
if ( $option ) {
update_option ( $option , $valid_page_found );
2014-08-13 09:59:37 +00:00
}
2015-09-07 13:17:22 +00:00
return $valid_page_found ;
2014-07-20 23:53:43 +00:00
}
2015-09-07 13:17:22 +00:00
// Search for a matching valid trashed page
if ( strlen ( $page_content ) > 0 ) {
// Search for an existing page with the specified page content (typically a shortcode)
$trashed_page_found = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status = 'trash' AND post_content LIKE %s LIMIT 1; " , " % { $page_content } % " ) );
} else {
// Search for an existing page with the specified page slug
$trashed_page_found = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status = 'trash' AND post_name = %s LIMIT 1; " , $slug ) );
2015-06-16 11:31:15 +00:00
}
2014-07-20 23:53:43 +00:00
2015-09-07 13:17:22 +00:00
if ( $trashed_page_found ) {
$page_id = $trashed_page_found ;
$page_data = array (
'ID' => $page_id ,
'post_status' => 'publish' ,
);
wp_update_post ( $page_data );
} else {
2015-06-16 11:31:15 +00:00
$page_data = array (
'post_status' => 'publish' ,
'post_type' => 'page' ,
'post_author' => 1 ,
'post_name' => $slug ,
'post_title' => $page_title ,
'post_content' => $page_content ,
'post_parent' => $post_parent ,
2016-08-27 01:46:45 +00:00
'comment_status' => 'closed' ,
2015-06-16 11:31:15 +00:00
);
2015-09-07 13:17:22 +00:00
$page_id = wp_insert_post ( $page_data );
2015-06-16 11:31:15 +00:00
}
2014-07-20 23:53:43 +00:00
2014-08-13 09:59:37 +00:00
if ( $option ) {
2014-07-20 23:53:43 +00:00
update_option ( $option , $page_id );
2014-08-13 09:59:37 +00:00
}
2014-07-20 23:53:43 +00:00
return $page_id ;
2013-07-26 14:36:28 +00:00
}
/**
* Output admin fields .
*
* Loops though the woocommerce options array and outputs each field .
*
* @ param array $options Opens array to output
*/
function woocommerce_admin_fields ( $options ) {
2014-11-30 06:52:32 +00:00
2017-02-16 11:46:01 +00:00
if ( ! class_exists ( 'WC_Admin_Settings' , false ) ) {
2016-07-27 10:58:43 +00:00
include ( dirname ( __FILE__ ) . '/class-wc-admin-settings.php' );
2014-09-22 18:30:07 +00:00
}
2013-07-26 14:36:28 +00:00
2014-07-20 23:53:43 +00:00
WC_Admin_Settings :: output_fields ( $options );
2013-07-26 14:36:28 +00:00
}
/**
* Update all settings which are passed .
*
* @ param array $options
2016-06-13 14:47:09 +00:00
* @ param array $data
2013-07-26 14:36:28 +00:00
*/
2016-06-13 14:47:09 +00:00
function woocommerce_update_options ( $options , $data = null ) {
2014-11-30 06:52:32 +00:00
2017-02-16 11:46:01 +00:00
if ( ! class_exists ( 'WC_Admin_Settings' , false ) ) {
2016-07-27 10:58:43 +00:00
include ( dirname ( __FILE__ ) . '/class-wc-admin-settings.php' );
2014-09-22 18:30:07 +00:00
}
2013-07-26 14:36:28 +00:00
2016-06-13 14:47:09 +00:00
WC_Admin_Settings :: save_fields ( $options , $data );
2013-07-26 14:36:28 +00:00
}
/**
* Get a setting from the settings API .
*
2014-09-07 23:37:55 +00:00
* @ param mixed $option_name
2016-01-05 15:49:41 +00:00
* @ param mixed $default
2013-07-26 14:36:28 +00:00
* @ return string
*/
function woocommerce_settings_get_option ( $option_name , $default = '' ) {
2014-11-30 06:52:32 +00:00
2017-02-16 11:46:01 +00:00
if ( ! class_exists ( 'WC_Admin_Settings' , false ) ) {
2016-07-27 10:58:43 +00:00
include ( dirname ( __FILE__ ) . '/class-wc-admin-settings.php' );
2014-09-22 18:30:07 +00:00
}
2013-07-26 14:36:28 +00:00
2014-07-20 23:53:43 +00:00
return WC_Admin_Settings :: get_option ( $option_name , $default );
2013-08-06 15:56:15 +00:00
}
2014-07-17 20:17:54 +00:00
/**
2016-08-19 12:43:33 +00:00
* Save order items . Uses the CRUD .
2014-07-17 20:17:54 +00:00
*
* @ since 2.2
* @ param int $order_id Order ID
* @ param array $items Order items to save
*/
function wc_save_order_items ( $order_id , $items ) {
2016-06-07 06:13:35 +00:00
// Allow other plugins to check change in order items before they are saved
do_action ( 'woocommerce_before_save_order_items' , $order_id , $items );
2016-08-25 12:50:37 +00:00
$order = wc_get_order ( $order_id );
2014-07-17 20:17:54 +00:00
2016-08-19 12:43:33 +00:00
// Line items and fees
2014-07-17 20:17:54 +00:00
if ( isset ( $items [ 'order_item_id' ] ) ) {
2016-08-25 12:50:37 +00:00
$data_keys = array (
'line_tax' => array (),
'line_subtotal_tax' => array (),
'order_item_name' => null ,
'order_item_qty' => null ,
'order_item_tax_class' => null ,
'line_total' => null ,
'line_subtotal' => null ,
);
2014-12-01 23:55:48 +00:00
foreach ( $items [ 'order_item_id' ] as $item_id ) {
2016-08-19 12:43:33 +00:00
if ( ! $item = $order -> get_item ( absint ( $item_id ) ) ) {
continue ;
}
2014-07-17 20:17:54 +00:00
2016-08-25 12:05:27 +00:00
$item_data = array ();
foreach ( $data_keys as $key => $default ) {
2016-08-25 16:42:47 +00:00
$item_data [ $key ] = isset ( $items [ $key ][ $item_id ] ) ? wc_clean ( wp_unslash ( $items [ $key ][ $item_id ] ) ) : $default ;
2016-08-25 12:05:27 +00:00
}
if ( '0' === $item_data [ 'order_item_qty' ] ) {
2016-08-24 15:09:39 +00:00
$item -> delete ();
continue ;
}
2016-08-24 15:02:19 +00:00
2016-08-25 12:05:27 +00:00
$item -> set_props ( array (
'name' => $item_data [ 'order_item_name' ],
'quantity' => $item_data [ 'order_item_qty' ],
'tax_class' => $item_data [ 'order_item_tax_class' ],
'total' => $item_data [ 'line_total' ],
'subtotal' => $item_data [ 'line_subtotal' ],
'taxes' => array (
'total' => $item_data [ 'line_tax' ],
'subtotal' => $item_data [ 'line_subtotal_tax' ],
),
) );
2014-07-17 20:17:54 +00:00
2016-08-19 12:43:33 +00:00
if ( isset ( $items [ 'meta_key' ][ $item_id ], $items [ 'meta_value' ][ $item_id ] ) ) {
foreach ( $items [ 'meta_key' ][ $item_id ] as $meta_id => $meta_key ) {
2017-04-06 20:58:24 +00:00
$meta_value = isset ( $items [ 'meta_value' ][ $item_id ][ $meta_id ] ) ? wp_unslash ( $items [ 'meta_value' ][ $item_id ][ $meta_id ] ) : '' ;
2016-08-19 12:43:33 +00:00
2016-08-25 16:10:59 +00:00
if ( '' === $meta_key && '' === $meta_value ) {
2016-08-25 12:05:27 +00:00
if ( ! strstr ( $meta_id , 'new-' ) ) {
$item -> delete_meta_data_by_mid ( $meta_id );
2016-08-19 12:43:33 +00:00
}
2016-08-25 12:05:27 +00:00
} elseif ( strstr ( $meta_id , 'new-' ) ) {
2016-08-19 12:43:33 +00:00
$item -> add_meta_data ( $meta_key , $meta_value , false );
} else {
$item -> update_meta_data ( $meta_key , $meta_value , $meta_id );
}
}
}
2014-07-17 20:17:54 +00:00
2016-08-19 12:43:33 +00:00
$item -> save ();
2015-06-15 15:22:53 +00:00
}
2014-07-17 20:17:54 +00:00
}
// Shipping Rows
if ( isset ( $items [ 'shipping_method_id' ] ) ) {
2016-08-25 12:50:37 +00:00
$data_keys = array (
'shipping_method' => null ,
'shipping_method_title' => null ,
'shipping_cost' => 0 ,
'shipping_taxes' => array (),
);
2017-04-06 20:58:24 +00:00
2014-12-01 23:55:48 +00:00
foreach ( $items [ 'shipping_method_id' ] as $item_id ) {
2016-08-19 12:43:33 +00:00
if ( ! $item = $order -> get_item ( absint ( $item_id ) ) ) {
continue ;
2014-07-20 23:53:43 +00:00
}
2016-08-24 15:02:19 +00:00
2016-08-25 12:50:37 +00:00
$item_data = array ();
foreach ( $data_keys as $key => $default ) {
2017-04-06 20:58:24 +00:00
$item_data [ $key ] = isset ( $items [ $key ][ $item_id ] ) ? wc_clean ( wp_unslash ( $items [ $key ][ $item_id ] ) ) : $default ;
2016-08-24 15:02:19 +00:00
}
2016-08-22 17:07:52 +00:00
2016-08-25 12:50:37 +00:00
$item -> set_props ( array (
'method_id' => $item_data [ 'shipping_method' ],
'method_title' => $item_data [ 'shipping_method_title' ],
'total' => $item_data [ 'shipping_cost' ],
'taxes' => array (
'total' => $item_data [ 'shipping_taxes' ],
),
) );
2016-08-22 17:07:52 +00:00
if ( isset ( $items [ 'meta_key' ][ $item_id ], $items [ 'meta_value' ][ $item_id ] ) ) {
foreach ( $items [ 'meta_key' ][ $item_id ] as $meta_id => $meta_key ) {
2017-04-06 20:58:24 +00:00
$meta_value = isset ( $items [ 'meta_value' ][ $item_id ][ $meta_id ] ) ? wp_unslash ( $items [ 'meta_value' ][ $item_id ][ $meta_id ] ) : '' ;
2016-08-22 17:07:52 +00:00
2016-08-25 16:10:59 +00:00
if ( '' === $meta_key && '' === $meta_value ) {
2016-08-25 12:50:37 +00:00
if ( ! strstr ( $meta_id , 'new-' ) ) {
$item -> delete_meta_data_by_mid ( $meta_id );
2016-08-22 17:07:52 +00:00
}
2016-08-25 12:50:37 +00:00
} elseif ( strstr ( $meta_id , 'new-' ) ) {
2016-08-22 17:07:52 +00:00
$item -> add_meta_data ( $meta_key , $meta_value , false );
} else {
$item -> update_meta_data ( $meta_key , $meta_value , $meta_id );
}
}
}
2016-08-19 12:43:33 +00:00
$item -> save ();
2014-07-20 23:53:43 +00:00
}
}
2016-08-19 12:43:33 +00:00
// Updates tax totals
$order -> update_taxes ();
2014-09-19 15:57:02 +00:00
2016-08-19 12:43:33 +00:00
// Calc totals - this also triggers save
$order -> calculate_totals ( false );
2015-03-16 12:17:09 +00:00
2016-06-07 06:13:35 +00:00
// Inform other plugins that the items have been saved
2014-09-19 16:08:54 +00:00
do_action ( 'woocommerce_saved_order_items' , $order_id , $items );
2014-07-17 20:17:54 +00:00
}