2013-08-06 10:41:20 +00:00
< ? php
/**
* WooCommerce Meta Boxes
*
* Sets up the write panels used by products and orders ( custom post types )
*
2014-11-30 06:52:32 +00:00
* @ author WooThemes
* @ category Admin
* @ package WooCommerce / Admin / Meta Boxes
2013-08-06 10:41:20 +00:00
* @ version 2.1 . 0
*/
2014-09-20 19:52:30 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
exit ; // Exit if accessed directly
}
2013-08-06 10:41:20 +00:00
/**
* WC_Admin_Meta_Boxes
*/
class WC_Admin_Meta_Boxes {
2015-02-04 11:34:59 +00:00
private static $saved_meta_boxes = false ;
2015-07-27 17:16:52 +00:00
public static $meta_box_errors = array ();
2013-08-06 10:41:20 +00:00
/**
* Constructor
*/
public function __construct () {
add_action ( 'add_meta_boxes' , array ( $this , 'remove_meta_boxes' ), 10 );
add_action ( 'add_meta_boxes' , array ( $this , 'rename_meta_boxes' ), 20 );
add_action ( 'add_meta_boxes' , array ( $this , 'add_meta_boxes' ), 30 );
add_action ( 'save_post' , array ( $this , 'save_meta_boxes' ), 1 , 2 );
2014-03-03 13:27:20 +00:00
/**
* Save Order Meta Boxes
*
* In order :
2014-11-30 06:52:32 +00:00
* Save the order items
* Save the order totals
* Save the order downloads
* Save order data - also updates status and sends out admin emails if needed . Last to show latest data .
* Save actions - sends out other emails . Last to show latest data .
2014-03-03 13:27:20 +00:00
*/
add_action ( 'woocommerce_process_shop_order_meta' , 'WC_Meta_Box_Order_Items::save' , 10 , 2 );
add_action ( 'woocommerce_process_shop_order_meta' , 'WC_Meta_Box_Order_Downloads::save' , 30 , 2 );
add_action ( 'woocommerce_process_shop_order_meta' , 'WC_Meta_Box_Order_Data::save' , 40 , 2 );
2013-08-06 10:41:20 +00:00
add_action ( 'woocommerce_process_shop_order_meta' , 'WC_Meta_Box_Order_Actions::save' , 50 , 2 );
// Save Product Meta Boxes
add_action ( 'woocommerce_process_product_meta' , 'WC_Meta_Box_Product_Data::save' , 10 , 2 );
add_action ( 'woocommerce_process_product_meta' , 'WC_Meta_Box_Product_Images::save' , 20 , 2 );
// Save Coupon Meta Boxes
add_action ( 'woocommerce_process_shop_coupon_meta' , 'WC_Meta_Box_Coupon_Data::save' , 10 , 2 );
2013-11-08 19:19:42 +00:00
// Save Rating Meta Boxes
2014-12-16 21:07:28 +00:00
add_action ( 'comment_edit_redirect' , 'WC_Meta_Box_Order_Reviews::save' , 1 , 2 );
2013-08-06 10:41:20 +00:00
// Error handling (for showing errors from meta boxes on next page load)
add_action ( 'admin_notices' , array ( $this , 'output_errors' ) );
add_action ( 'shutdown' , array ( $this , 'save_errors' ) );
}
/**
* Add an error message
* @ param string $text
*/
public static function add_error ( $text ) {
self :: $meta_box_errors [] = $text ;
}
/**
* Save errors to an option
*/
public function save_errors () {
update_option ( 'woocommerce_meta_box_errors' , self :: $meta_box_errors );
}
/**
* Show any stored error messages .
*/
public function output_errors () {
$errors = maybe_unserialize ( get_option ( 'woocommerce_meta_box_errors' ) );
2013-12-11 01:43:12 +00:00
if ( ! empty ( $errors ) ) {
2013-08-06 10:41:20 +00:00
2015-05-05 12:28:03 +00:00
echo '<div id="woocommerce_errors" class="error">' ;
2014-11-30 06:52:32 +00:00
2013-12-11 01:43:12 +00:00
foreach ( $errors as $error ) {
2015-05-26 15:49:41 +00:00
echo '<p>' . wp_kses_post ( $error ) . '</p>' ;
2013-12-11 01:43:12 +00:00
}
2014-11-30 06:52:32 +00:00
2013-12-11 01:43:12 +00:00
echo '</div>' ;
2013-08-06 10:41:20 +00:00
2013-12-11 01:43:12 +00:00
// Clear
delete_option ( 'woocommerce_meta_box_errors' );
}
2013-08-06 10:41:20 +00:00
}
/**
* Add WC Meta boxes
*/
public function add_meta_boxes () {
// Products
add_meta_box ( 'postexcerpt' , __ ( 'Product Short Description' , 'woocommerce' ), 'WC_Meta_Box_Product_Short_Description::output' , 'product' , 'normal' );
add_meta_box ( 'woocommerce-product-data' , __ ( 'Product Data' , 'woocommerce' ), 'WC_Meta_Box_Product_Data::output' , 'product' , 'normal' , 'high' );
2014-11-24 15:29:37 +00:00
add_meta_box ( 'woocommerce-product-images' , __ ( 'Product Gallery' , 'woocommerce' ), 'WC_Meta_Box_Product_Images::output' , 'product' , 'side' , 'low' );
2013-08-06 10:41:20 +00:00
// Orders
2014-07-11 11:43:42 +00:00
foreach ( wc_get_order_types ( 'order-meta-boxes' ) as $type ) {
2014-10-07 05:22:16 +00:00
$order_type_object = get_post_type_object ( $type );
add_meta_box ( 'woocommerce-order-data' , sprintf ( __ ( '%s Data' , 'woocommerce' ), $order_type_object -> labels -> singular_name ), 'WC_Meta_Box_Order_Data::output' , $type , 'normal' , 'high' );
add_meta_box ( 'woocommerce-order-items' , sprintf ( __ ( '%s Items' , 'woocommerce' ), $order_type_object -> labels -> singular_name ), 'WC_Meta_Box_Order_Items::output' , $type , 'normal' , 'high' );
add_meta_box ( 'woocommerce-order-notes' , sprintf ( __ ( '%s Notes' , 'woocommerce' ), $order_type_object -> labels -> singular_name ), 'WC_Meta_Box_Order_Notes::output' , $type , 'side' , 'default' );
2014-07-11 11:43:42 +00:00
add_meta_box ( 'woocommerce-order-downloads' , __ ( 'Downloadable Product Permissions' , 'woocommerce' ) . ' <span class="tips" data-tip="' . __ ( 'Note: Permissions for order items will automatically be granted when the order status changes to processing/completed.' , 'woocommerce' ) . '">[?]</span>' , 'WC_Meta_Box_Order_Downloads::output' , $type , 'normal' , 'default' );
2014-10-07 05:22:16 +00:00
add_meta_box ( 'woocommerce-order-actions' , sprintf ( __ ( '%s Actions' , 'woocommerce' ), $order_type_object -> labels -> singular_name ), 'WC_Meta_Box_Order_Actions::output' , $type , 'side' , 'high' );
2015-04-27 10:13:49 +00:00
remove_meta_box ( 'submitdiv' , $type , 'side' );
2014-07-11 11:43:42 +00:00
}
2013-08-06 10:41:20 +00:00
// Coupons
2013-11-08 19:19:42 +00:00
add_meta_box ( 'woocommerce-coupon-data' , __ ( 'Coupon Data' , 'woocommerce' ), 'WC_Meta_Box_Coupon_Data::output' , 'shop_coupon' , 'normal' , 'high' );
// Reviews
2013-12-11 01:42:31 +00:00
if ( 'comment' == get_current_screen () -> id && isset ( $_GET [ 'c' ] ) ) {
if ( get_comment_meta ( intval ( $_GET [ 'c' ] ), 'rating' , true ) ) {
add_meta_box ( 'woocommerce-rating' , __ ( 'Rating' , 'woocommerce' ), 'WC_Meta_Box_Order_Reviews::output' , 'comment' , 'normal' , 'high' );
}
}
2013-08-06 10:41:20 +00:00
}
/**
* Remove bloat
*/
public function remove_meta_boxes () {
remove_meta_box ( 'postexcerpt' , 'product' , 'normal' );
remove_meta_box ( 'product_shipping_classdiv' , 'product' , 'side' );
remove_meta_box ( 'pageparentdiv' , 'product' , 'side' );
remove_meta_box ( 'commentstatusdiv' , 'product' , 'normal' );
remove_meta_box ( 'commentstatusdiv' , 'product' , 'side' );
remove_meta_box ( 'woothemes-settings' , 'shop_coupon' , 'normal' );
remove_meta_box ( 'commentstatusdiv' , 'shop_coupon' , 'normal' );
remove_meta_box ( 'slugdiv' , 'shop_coupon' , 'normal' );
2014-07-11 11:43:42 +00:00
foreach ( wc_get_order_types ( 'order-meta-boxes' ) as $type ) {
remove_meta_box ( 'commentsdiv' , $type , 'normal' );
remove_meta_box ( 'woothemes-settings' , $type , 'normal' );
remove_meta_box ( 'commentstatusdiv' , $type , 'normal' );
remove_meta_box ( 'slugdiv' , $type , 'normal' );
}
2013-08-06 10:41:20 +00:00
}
/**
* Rename core meta boxes
*/
public function rename_meta_boxes () {
global $post ;
// Comments/Reviews
2013-12-11 01:48:03 +00:00
if ( isset ( $post ) && ( 'publish' == $post -> post_status || 'private' == $post -> post_status ) ) {
2013-08-06 10:41:20 +00:00
remove_meta_box ( 'commentsdiv' , 'product' , 'normal' );
add_meta_box ( 'commentsdiv' , __ ( 'Reviews' , 'woocommerce' ), 'post_comment_meta_box' , 'product' , 'normal' );
}
}
/**
* Check if we ' re saving , the trigger an action based on the post type
*
* @ param int $post_id
* @ param object $post
*/
public function save_meta_boxes ( $post_id , $post ) {
2014-04-07 13:15:51 +00:00
// $post_id and $post are required
2015-02-04 11:34:59 +00:00
if ( empty ( $post_id ) || empty ( $post ) || self :: $saved_meta_boxes ) {
2014-04-07 13:15:51 +00:00
return ;
}
// Dont' save meta boxes for revisions or autosaves
if ( defined ( 'DOING_AUTOSAVE' ) || is_int ( wp_is_post_revision ( $post ) ) || is_int ( wp_is_post_autosave ( $post ) ) ) {
return ;
}
2014-07-20 23:53:55 +00:00
2014-04-07 13:15:51 +00:00
// Check the nonce
if ( empty ( $_POST [ 'woocommerce_meta_nonce' ] ) || ! wp_verify_nonce ( $_POST [ 'woocommerce_meta_nonce' ], 'woocommerce_save_data' ) ) {
return ;
2014-07-20 23:53:55 +00:00
}
2014-04-07 13:15:51 +00:00
// Check the post being saved == the $post_id to prevent triggering this call for other save_post events
if ( empty ( $_POST [ 'post_ID' ] ) || $_POST [ 'post_ID' ] != $post_id ) {
return ;
}
// Check user has permission to edit
if ( ! current_user_can ( 'edit_post' , $post_id ) ) {
return ;
}
2015-02-04 11:34:59 +00:00
// We need this save event to run once to avoid potential endless loops. This would have been perfect:
// remove_action( current_filter(), __METHOD__ );
// But cannot be used due to https://github.com/woothemes/woocommerce/issues/6485
// When that is patched in core we cna use the above. For now:
self :: $saved_meta_boxes = true ;
2014-04-07 13:15:51 +00:00
// Check the post type
2014-07-11 11:43:42 +00:00
if ( in_array ( $post -> post_type , wc_get_order_types ( 'order-meta-boxes' ) ) ) {
do_action ( 'woocommerce_process_shop_order_meta' , $post_id , $post );
2015-01-08 18:34:30 +00:00
} elseif ( in_array ( $post -> post_type , array ( 'product' , 'shop_coupon' ) ) ) {
2014-07-11 11:43:42 +00:00
do_action ( 'woocommerce_process_' . $post -> post_type . '_meta' , $post_id , $post );
2014-04-07 13:15:51 +00:00
}
2013-08-06 10:41:20 +00:00
}
}
2013-11-08 19:19:42 +00:00
new WC_Admin_Meta_Boxes ();