capabilities = preg_filter( '/^/', ATUM_PREFIX, $this->capabilities );
// Add the ATUM Orders' meta table to wpdb.
global $wpdb;
if ( ! in_array( self::ORDER_ITEM_META_TABLE, $wpdb->tables ) ) {
$wpdb->atum_order_itemmeta = $wpdb->prefix . self::ORDER_ITEM_META_TABLE;
$wpdb->tables[] = self::ORDER_ITEM_META_TABLE;
}
// Register the post type.
add_action( 'init', array( $this, 'register_post_type' ) );
/* @noinspection PhpUndefinedClassConstantInspection */
$post_type = static::POST_TYPE;
if ( is_admin() ) {
// Add the custom columns to the post type list table.
add_filter( "manage_{$post_type}_posts_columns", array( $this, 'add_columns' ) );
add_action( "manage_{$post_type}_posts_custom_column", array( $this, 'render_columns' ), 2 );
add_filter( 'post_row_actions', array( $this, 'row_actions' ), 2, 100 );
add_filter( "manage_edit-{$post_type}_sortable_columns", array( $this, 'sortable_columns' ) );
add_filter( 'list_table_primary_column', array( $this, 'list_table_primary_column' ), 10, 2 );
// Filters and sorts the ATUM Orders' list tables.
add_filter( 'request', array( $this, 'request_query' ) );
// Add meta boxes to ATUM Order UI.
add_action( "add_meta_boxes_{$post_type}", array( $this, 'add_meta_boxes' ), 30 );
// Save the meta boxes.
add_action( "save_post_{$post_type}", array( $this, 'save_meta_boxes' ) );
// Disable post type view mode options.
add_filter( 'view_mode_post_types', array( $this, 'disable_view_mode_options' ) );
// Disable Auto Save.
add_action( 'admin_print_scripts', array( $this, 'disable_autosave' ) );
// Post update messages.
add_filter( 'post_updated_messages', array( $this, 'post_updated_messages' ) );
// Bulk actions.
add_filter( "bulk_actions-edit-{$post_type}", array( $this, 'add_bulk_actions' ) );
add_filter( "handle_bulk_actions-edit-{$post_type}", array( $this, 'handle_bulk_actions' ), 10, 3 );
add_action( 'admin_notices', array( $this, 'bulk_admin_notices' ) );
add_filter( 'bulk_post_updated_messages', array( $this, 'bulk_post_updated_messages' ), 10, 2 );
// Enqueue scripts.
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 );
add_action( 'admin_footer', array( $this, 'print_scripts' ) );
// ATUM Orders search.
add_filter( 'get_search_query', array( $this, 'search_label' ) );
add_filter( 'query_vars', array( $this, 'add_custom_search_query_var' ) );
add_action( 'parse_query', array( $this, 'search_custom_fields' ) );
}
// Recalculate the ATUM props for products within ATUM Orders, every time an ATUM Order is moved or restored from trash.
add_action( 'trashed_post', array( $this, 'update_order_item_props' ) );
add_action( 'untrashed_post', array( $this, 'update_order_item_props' ) );
do_action( 'atum/order_post_type/init', $post_type );
}
/**
* Register the ATUM Order post type
*
* @param array $args
*
* @since 1.2.9
*/
public function register_post_type( $args = array() ) {
// Minimum capability required.
$read_capability = isset( $this->capabilities['read_post'] ) ? $this->capabilities['read_post'] : 'manage_woocommerce';
$is_user_allowed = current_user_can( $read_capability );
$main_menu_item = Main::get_main_menu_item();
/* @noinspection PhpUndefinedClassConstantInspection */
$post_type = static::POST_TYPE;
$args = apply_filters( 'atum/order_post_type/post_type_args', wp_parse_args( array(
'labels' => $this->labels,
'description' => __( 'This is where ATUM orders are stored.', ATUM_TEXT_DOMAIN ),
'public' => FALSE,
'show_ui' => $is_user_allowed,
'publicly_queryable' => FALSE,
'exclude_from_search' => TRUE,
'show_in_menu' => $is_user_allowed ? $main_menu_item['slug'] : FALSE,
'hierarchical' => FALSE,
'show_in_nav_menus' => FALSE,
'rewrite' => FALSE,
'query_var' => is_admin(),
'supports' => array( 'title', 'comments', 'custom-fields' ),
'has_archive' => FALSE,
'capabilities' => $this->capabilities,
), $args ));
// Register the ATUM Order post type.
register_post_type( $post_type, $args );
// Register the post statuses.
$atum_statuses = [];
foreach ( static::get_statuses() as $status => $label ) {
$count = "$label (%s)";
$atum_statuses[ $status ] = array(
'label' => $label,
'public' => FALSE,
'exclude_from_search' => FALSE,
'show_in_admin_all_list' => TRUE,
'show_in_admin_status_list' => TRUE,
/* translators: the count of orders in current status */
'label_count' => array(
0 => $count,
1 => $count,
'singular' => $count,
'plural' => $count,
'context' => NULL,
'domain' => ATUM_TEXT_DOMAIN,
),
);
}
$atum_statuses = (array) apply_filters( 'atum/order_post_type/register_post_statuses', $atum_statuses );
foreach ( $atum_statuses as $atum_status => $values ) {
register_post_status( $atum_status, $values );
}
// Register the taxomony only if needed by the custom post type.
/* @noinspection PhpUndefinedClassConstantInspection */
if ( defined( 'static::TAXONOMY' ) && ! empty( static::TAXONOMY ) ) {
$args = apply_filters( 'atum/order_post_type/taxonomy_args', wp_parse_args( array(
'hierarchical' => FALSE,
'show_ui' => FALSE,
'show_in_nav_menus' => FALSE,
'query_var' => is_admin(),
'rewrite' => FALSE,
'public' => FALSE,
'update_count_callback' => array( $this, 'order_term_recount' ),
), $args ));
// Register the hidden order type taxonomy (if used).
/* @noinspection PhpUndefinedClassConstantInspection */
register_taxonomy( static::TAXONOMY, array( $post_type ), $args );
}
}
/**
* Method for recounting order terms (types)
*
* @since 1.2.9
*
* @param array $terms
* @param \WP_Taxonomy $taxonomy
*/
public function order_term_recount( $terms, $taxonomy ) {
global $wpdb;
// Custom version of the WP "_update_post_term_count()" function.
$object_types = (array) $taxonomy->object_type;
foreach ( $object_types as &$object_type ) {
list( $object_type ) = explode( ':', $object_type );
}
$object_types = array_unique( $object_types );
if ( $object_types ) {
$object_types = esc_sql( array_filter( $object_types, 'post_type_exists' ) );
}
foreach ( (array) $terms as $term ) {
$count = 0;
// Count all the orders with one of the ATUM Order's statuses.
if ( $object_types ) {
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
$count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts WHERE $wpdb->posts.ID = $wpdb->term_relationships.object_id AND post_status IN ('" . implode( "','", array_keys( $this->get_statuses() ) ) . "') AND post_type IN ('" . implode( "', '", $object_types ) . "') AND term_taxonomy_id = %d", $term ) ); // WPCS: unprepared SQL ok.
}
// This action is documented in wp-includes/taxonomy.php.
do_action( 'edit_term_taxonomy', $term, $taxonomy->name ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
$wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
// This action is documented in wp-includes/taxonomy.php.
do_action( 'edited_term_taxonomy', $term, $taxonomy->name ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
}
}
/**
* Filters and sorting handler
*
* @since 1.2.4
*
* @param array $vars
*
* @return array
*/
public function request_query( $vars ) {
global $typenow, $wp_post_statuses;
/* @noinspection PhpUndefinedClassConstantInspection */
if ( static::POST_TYPE === $typenow ) {
// Sorting.
if ( isset( $vars['orderby'] ) && 'total' === $vars['orderby'] ) {
$vars = array_merge( $vars, array(
'meta_key' => '_total',
'orderby' => 'meta_value_num',
) );
}
// Status.
if ( empty( $vars['post_status'] ) ) {
// All the ATUM Order posts must have the custom statuses created for them.
$statuses = array_keys( $this->get_statuses() );
foreach ( $statuses as $key => $status ) {
if ( isset( $wp_post_statuses[ $status ] ) && FALSE === $wp_post_statuses[ $status ]->show_in_admin_all_list ) {
unset( $statuses[ $key ] );
}
}
$vars['post_status'] = $statuses;
}
}
return $vars;
}
/**
* Customize the columns used in the ATUM Order's list table
*
* @since 1.2.4
*
* @param array $existing_columns
*
* @return array
*/
abstract public function add_columns( $existing_columns );
/**
* Output custom columns for ATUM Order's list table
*
* @since 1.2.4
*
* @param string $column
*
* @return bool True if the column is rendered or False if not
*/
public function render_columns( $column ) {
global $post;
$rendered = FALSE;
/* @noinspection PhpUndefinedClassConstantInspection */
$post_type = static::POST_TYPE;
switch ( $column ) {
case 'status':
$statuses = static::get_statuses();
$atum_order = Helpers::get_atum_order_model( $post->ID );
if ( ! is_wp_error( $atum_order ) ) {
$status = $atum_order->get_status();
$status_name = isset( $statuses[ $status ] ) ? $statuses[ $status ] : '';
printf( '%2$s', esc_attr( sanitize_html_class( str_replace( ATUM_PREFIX, '', $status ) ) ), esc_html( $status_name ) );
}
break;
case 'atum_order_title':
$author = $post->post_author;
if ( $author ) {
$user = get_user_by( 'id', $author );
if ( is_a( $user, '\WP_User' ) ) {
$username = ucwords( $user->display_name );
}
else {
$username = __( 'User not found', ATUM_TEXT_DOMAIN );
}
}
else {
$username = 'ATUM';
}
echo '#' . esc_attr( $post->ID ) . ' ' . $username . ''; // WPCS: XSS ok.
$rendered = TRUE;
break;
case 'date':
printf( '', date_i18n( 'Y-m-d', strtotime( $post->post_date ) ) ); // WPCS: XSS ok.
$rendered = TRUE;
break;
case 'notes':
if ( $post->comment_count && AtumCapabilities::current_user_can( 'read_order_notes' ) ) {
// Check the status of the post.
$status = ( 'trash' !== $post->post_status ) ? '' : 'post-trashed';
$latest_notes = get_comments( array(
'post_id' => $post->ID,
'number' => 1,
'status' => $status,
) );
$latest_note = current( $latest_notes );
if ( isset( $latest_note->comment_content ) && 1 == $post->comment_count ) { // WPCS: loose comparison ok.
echo '' . esc_attr__( 'Yes', ATUM_TEXT_DOMAIN ) . ''; // WPCS: XSS ok.
}
elseif ( isset( $latest_note->comment_content ) ) {
/* translators: the notes' count */
echo '' . sprintf( _n( 'plus %d other note', 'plus %d other notes', ( $post->comment_count - 1 ), ATUM_TEXT_DOMAIN ), $post->comment_count - 1 ) . '' ) . '">' . esc_attr__( 'Yes', ATUM_TEXT_DOMAIN ) . ''; // WPCS: XSS ok.
}
else {
/* translators: the notes' count */
echo '' . esc_attr__( 'Yes', ATUM_TEXT_DOMAIN ) . ''; // WPCS: XSS ok.
}
}
else {
echo '–';
}
$rendered = TRUE;
break;
case 'total':
$atum_order = Helpers::get_atum_order_model( $post->ID );
if ( ! is_wp_error( $atum_order ) ) {
echo $atum_order->get_formatted_total(); // WPCS: XSS ok.
}
break;
case 'actions':
$atum_order = Helpers::get_atum_order_model( $post->ID );
if ( is_wp_error( $atum_order ) ) {
break;
}
?>
get_status() ) {
if ( isset( $statuses[ static::FINISHED ] ) ) {
$actions['complete'] = array(
'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=atum_order_mark_status&status=' . static::FINISHED . "&atum_order_id=$post->ID" ), 'atum-order-mark-status' ),
/* translators: Change the order's status to finished */
'name' => sprintf( __( 'Mark as %s', ATUM_TEXT_DOMAIN ), $statuses[ static::FINISHED ] ),
'action' => 'complete',
'target' => '_self',
'icon' => '',
);
}
}
$actions = apply_filters( "atum/$post_type/admin_order_actions", $actions, $atum_order );
foreach ( $actions as $action ) {
printf( '%5$s', esc_attr( $action['action'] ), esc_attr( $action['target'] ), esc_url( $action['url'] ), esc_attr( $action['name'] ), $action['icon'] ); // WPCS: XSS ok.
}
do_action( "atum/$post_type/admin_actions_end", $atum_order ); ?>
post_type && isset( $actions['inline hide-if-no-js'] ) ) {
unset( $actions['inline hide-if-no-js'] );
}
return $actions;
}
/**
* Set the primary column for the ATUM Orders' table list
*
* @since 1.2.0
*
* @param string $default
* @param string $screen_id
*
* @return string
*/
public function list_table_primary_column( $default, $screen_id ) {
/* @noinspection PhpUndefinedClassConstantInspection */
if ( 'edit-' . static::POST_TYPE === $screen_id ) {
return 'atum_order_title';
}
return $default;
}
/**
* Make columns sortable - https://gist.github.com/906872
*
* @since 1.2.4
*
* @param array $columns
*
* @return array
*/
public function sortable_columns( $columns ) {
$custom = array(
'atum_order_title' => 'ID',
'total' => 'total',
'date' => 'date',
);
unset( $columns['comments'] );
return wp_parse_args( $custom, $columns );
}
/**
* Add the ATUM Order's meta boxes
*
* @since 1.2.9
*/
public function add_meta_boxes() {
/* @noinspection PhpUndefinedClassConstantInspection */
$post_type = static::POST_TYPE;
// Data meta box.
add_meta_box(
'atum_order_data',
! empty( $this->metabox_labels['data'] ) ? $this->metabox_labels['data'] : __( 'Data', ATUM_TEXT_DOMAIN ),
array( $this, 'show_data_meta_box' ),
$post_type,
'normal',
'high'
);
// Items meta box.
add_meta_box(
'atum_order_items',
! empty( $this->metabox_labels['items'] ) ? $this->metabox_labels['items'] : __( 'Items', ATUM_TEXT_DOMAIN ),
array( $this, 'show_items_meta_box' ),
$post_type,
'normal',
'high'
);
// Notes meta box.
if ( AtumCapabilities::current_user_can( 'read_order_notes' ) ) {
add_meta_box(
'atum_order_notes',
! empty( $this->metabox_labels['notes'] ) ? $this->metabox_labels['notes'] : __( 'Notes', ATUM_TEXT_DOMAIN ),
array( $this, 'show_notes_meta_box' ),
$post_type,
'side',
'default'
);
}
// Actions meta box.
add_meta_box(
'atum_order_actions',
! empty( $this->metabox_labels['actions'] ) ? $this->metabox_labels['actions'] : __( 'Actions', ATUM_TEXT_DOMAIN ),
array( $this, 'show_actions_meta_box' ),
$post_type,
'side',
'high'
);
// Remove unneeded WP meta boxes.
remove_meta_box( 'commentsdiv', $post_type, 'normal' );
remove_meta_box( 'commentstatusdiv', $post_type, 'normal' );
remove_meta_box( 'slugdiv', $post_type, 'normal' );
remove_meta_box( 'submitdiv', $post_type, 'side' );
}
/**
* Displays the Data meta box at ATUM Order posts
*
* @since 1.2.9
*
* @param \WP_Post $post
*/
abstract public function show_data_meta_box( $post );
/**
* Displays the Items meta box at ATUM Order posts
*
* @since 1.2.9
*
* @param \WP_Post $post
*/
public function show_items_meta_box( $post ) {
$atum_order = $this->get_current_atum_order( $post->ID );
Helpers::load_view( 'meta-boxes/atum-order/items', compact( 'atum_order' ) );
}
/**
* Displays the Notes meta box at ATUM Order posts
*
* @since 1.2.9
*
* @param \WP_Post $post
*/
public function show_notes_meta_box( $post ) {
Helpers::load_view( 'meta-boxes/atum-order/notes', compact( 'post' ) );
}
/**
* Displays the Actions meta box at ATUM Order posts
*
* @since 1.2.9
*
* @param \WP_Post $post
*/
public function show_actions_meta_box( $post ) {
Helpers::load_view( 'meta-boxes/atum-order/actions', compact( 'post' ) );
}
/**
* Save the ATUM Order meta boxes
*
* @since 1.2.9
*
* @param int $atum_order_id
*/
abstract public function save_meta_boxes( $atum_order_id );
/**
* Removes ATUM Orders from the list of post types that support "View Mode" switching.
* View mode is seen on posts where you can switch between list or excerpt. Our post types don't support
* it, so we want to hide the useless UI from the screen options tab.
*
* @since 1.2.9
*
* @param array $post_types Post types supporting view mode.
*
* @return array
*/
public function disable_view_mode_options( $post_types ) {
/* @noinspection PhpUndefinedClassConstantInspection */
unset( $post_types[ static::POST_TYPE ] );
return $post_types;
}
/**
* Disable the WP auto-save functionality for ATUM Orders
*
* @since 1.2.4
*/
public function disable_autosave() {
global $post;
/* @noinspection PhpUndefinedClassConstantInspection */
if ( $post && get_post_type( $post->ID ) === static::POST_TYPE ) {
wp_dequeue_script( 'autosave' );
}
}
/**
* Manipulate ATUM Orders' bulk actions
*
* @since 1.2.4
*
* @param array $actions List of actions.
*
* @return array
*/
public function add_bulk_actions( $actions ) {
if ( isset( $actions['edit'] ) ) {
unset( $actions['edit'] );
}
foreach ( static::get_statuses() as $status => $label ) {
/* translators: Change the order's status to $status */
$actions[ "atum_order_mark_$status" ] = sprintf( __( 'Mark as %s', ATUM_TEXT_DOMAIN ), $label );
}
return $actions;
}
/**
* Handle ATUM Orders' bulk actions
*
* @since 1.2.4
*
* @param string $redirect_to URL to redirect to.
* @param string $action Action name.
* @param array $ids List of ids.
*
* @return string
*/
public function handle_bulk_actions( $redirect_to, $action, $ids ) {
// Bail out if this is not a status-changing action.
if ( FALSE === strpos( $action, 'atum_order_mark_' ) ) {
return $redirect_to;
}
$statuses = static::get_statuses();
$new_status = substr( $action, 16 ); // Get the status name from action (removing 'atum_order_mark_' = 16 characters).
$report_action = "marked_$new_status";
// Sanity check: bail out if this is actually not a status, or is not a registered status.
if ( ! isset( $statuses[ $new_status ] ) ) {
return $redirect_to;
}
$changed = 0;
$ids = array_map( 'absint', $ids );
/* @noinspection PhpUndefinedClassConstantInspection */
$post_type = static::POST_TYPE;
foreach ( $ids as $id ) {
$atum_order = Helpers::get_atum_order_model( $id );
$atum_order->update_status( $new_status );
$changed++;
}
$redirect_to = add_query_arg( array(
'post_type' => $post_type,
$report_action => TRUE,
'changed' => $changed,
'ids' => implode( ',', $ids ),
), $redirect_to );
return esc_url_raw( $redirect_to );
}
/**
* Show confirmation message that ATUM Order status changed for number of orders
*
* @since 1.2.4
*/
public function bulk_admin_notices() {
global $post_type, $pagenow;
// Bail out if not on ATUM Order's list page.
/* @noinspection PhpUndefinedClassConstantInspection */
if ( 'edit.php' !== $pagenow || static::POST_TYPE !== $post_type ) {
return;
}
$statuses = static::get_statuses();
// Check if any status changes happened.
foreach ( $statuses as $slug => $name ) {
if ( isset( $_REQUEST[ "marked_$slug" ] ) ) {
$number = isset( $_REQUEST['changed'] ) ? absint( $_REQUEST['changed'] ) : 0;
/* translators: the number of changed statuses */
$message = sprintf( _n( '%s status changed.', '%s statuses changed.', $number, ATUM_TEXT_DOMAIN ), number_format_i18n( $number ) );
echo '' . esc_html( $message ) . '