296 lines
7.4 KiB
PHP
296 lines
7.4 KiB
PHP
<?php
|
|
/**
|
|
* WooCommerce Admin (Dashboard) Order Milestones Note Provider.
|
|
*
|
|
* Adds a note to the merchant's inbox when certain order milestones are reached.
|
|
*
|
|
* @package WooCommerce Admin
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* WC_Admin_Notes_Order_Milestones
|
|
*/
|
|
class WC_Admin_Notes_Order_Milestones {
|
|
/**
|
|
* Name of the "other milestones" note.
|
|
*/
|
|
const ORDERS_MILESTONE_NOTE_NAME = 'wc-admin-orders-milestone';
|
|
|
|
/**
|
|
* Option key name to store last order milestone.
|
|
*/
|
|
const LAST_ORDER_MILESTONE_OPTION_KEY = 'wc_admin_last_orders_milestone';
|
|
|
|
/**
|
|
* Hook to process order milestones.
|
|
*/
|
|
const PROCESS_ORDERS_MILESTONE_HOOK = 'wc_admin_process_orders_milestone';
|
|
|
|
/**
|
|
* Allowed order statuses for calculating milestones.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $allowed_statuses = array(
|
|
'pending',
|
|
'processing',
|
|
'completed',
|
|
);
|
|
|
|
/**
|
|
* Orders count cache.
|
|
*
|
|
* @var int
|
|
*/
|
|
protected $orders_count = null;
|
|
|
|
/**
|
|
* Further order milestone thresholds.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $milestones = array(
|
|
1,
|
|
10,
|
|
100,
|
|
250,
|
|
500,
|
|
1000,
|
|
5000,
|
|
10000,
|
|
500000,
|
|
1000000,
|
|
);
|
|
|
|
/**
|
|
* Delay hook attachment until after the WC post types have been registered.
|
|
*
|
|
* This is required for retrieving the order count.
|
|
*/
|
|
public function __construct() {
|
|
/**
|
|
* Filter Order statuses that will count towards milestones.
|
|
*
|
|
* @since 3.5.0
|
|
*
|
|
* @param array $allowed_statuses Order statuses that will count towards milestones.
|
|
*/
|
|
$this->allowed_statuses = apply_filters( 'woocommerce_admin_order_milestone_statuses', $this->allowed_statuses );
|
|
|
|
add_action( 'woocommerce_after_register_post_type', array( $this, 'init' ) );
|
|
register_deactivation_hook( WC_ADMIN_PLUGIN_FILE, array( $this, 'clear_scheduled_event' ) );
|
|
}
|
|
|
|
/**
|
|
* Hook everything up.
|
|
*/
|
|
public function init() {
|
|
if ( ! wp_next_scheduled( self::PROCESS_ORDERS_MILESTONE_HOOK ) ) {
|
|
wp_schedule_event( time(), 'hourly', self::PROCESS_ORDERS_MILESTONE_HOOK );
|
|
}
|
|
|
|
add_action( 'wc_admin_installed', array( $this, 'backfill_last_milestone' ) );
|
|
|
|
add_action( self::PROCESS_ORDERS_MILESTONE_HOOK, array( $this, 'other_milestones' ) );
|
|
}
|
|
|
|
/**
|
|
* Clear out our hourly milestone hook upon plugin deactivation.
|
|
*/
|
|
public function clear_scheduled_event() {
|
|
wp_clear_scheduled_hook( self::PROCESS_ORDERS_MILESTONE_HOOK );
|
|
}
|
|
|
|
/**
|
|
* Get the total count of orders (in the allowed statuses).
|
|
*
|
|
* @param bool $no_cache Optional. Skip cache.
|
|
* @return int Total orders count.
|
|
*/
|
|
public function get_orders_count( $no_cache = false ) {
|
|
if ( $no_cache || is_null( $this->orders_count ) ) {
|
|
$status_counts = array_map( 'wc_orders_count', $this->allowed_statuses );
|
|
$this->orders_count = array_sum( $status_counts );
|
|
}
|
|
|
|
return $this->orders_count;
|
|
}
|
|
|
|
/**
|
|
* Backfill the store's current milestone.
|
|
*
|
|
* Used to avoid celebrating milestones that were reached before plugin activation.
|
|
*/
|
|
public function backfill_last_milestone() {
|
|
$this->set_last_milestone( $this->get_current_milestone() );
|
|
}
|
|
|
|
/**
|
|
* Get the store's last milestone.
|
|
*
|
|
* @return int Last milestone reached.
|
|
*/
|
|
public function get_last_milestone() {
|
|
return get_option( self::LAST_ORDER_MILESTONE_OPTION_KEY, 0 );
|
|
}
|
|
|
|
/**
|
|
* Update the last reached milestone.
|
|
*
|
|
* @param int $milestone Last milestone reached.
|
|
*/
|
|
public function set_last_milestone( $milestone ) {
|
|
update_option( self::LAST_ORDER_MILESTONE_OPTION_KEY, $milestone );
|
|
}
|
|
|
|
/**
|
|
* Calculate the current orders milestone.
|
|
*
|
|
* Based on the threshold values in $this->milestones.
|
|
*
|
|
* @return int Current orders milestone.
|
|
*/
|
|
public function get_current_milestone() {
|
|
$milestone_reached = 0;
|
|
$orders_count = $this->get_orders_count();
|
|
|
|
foreach ( $this->milestones as $milestone ) {
|
|
if ( $milestone <= $orders_count ) {
|
|
$milestone_reached = $milestone;
|
|
}
|
|
}
|
|
|
|
return $milestone_reached;
|
|
}
|
|
|
|
/**
|
|
* Get the appropriate note title for a given milestone.
|
|
*
|
|
* @param int $milestone Order milestone.
|
|
* @return string Note title for the milestone.
|
|
*/
|
|
public function get_note_title_for_milestone( $milestone ) {
|
|
switch ( $milestone ) {
|
|
case 1:
|
|
return __( 'First order', 'woocommerce-admin' );
|
|
case 10:
|
|
case 100:
|
|
case 250:
|
|
case 500:
|
|
case 1000:
|
|
case 5000:
|
|
case 10000:
|
|
case 500000:
|
|
case 1000000:
|
|
return sprintf(
|
|
/* translators: Number of orders processed. */
|
|
__( 'Congratulations on processing %s orders!', 'woocommerce-admin' ),
|
|
wc_format_decimal( $milestone )
|
|
);
|
|
default:
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the appropriate note content for a given milestone.
|
|
*
|
|
* @param int $milestone Order milestone.
|
|
* @return string Note content for the milestone.
|
|
*/
|
|
public function get_note_content_for_milestone( $milestone ) {
|
|
switch ( $milestone ) {
|
|
case 1:
|
|
return __( 'Congratulations on getting your first order from a customer! Learn how to manage your orders.', 'woocommerce-admin' );
|
|
case 10:
|
|
return __( "You've hit the 10 orders milestone! Look at you go. Browse some WooCommerce success stories for inspiration.", 'woocommerce-admin' );
|
|
case 100:
|
|
case 250:
|
|
case 500:
|
|
case 1000:
|
|
case 5000:
|
|
case 10000:
|
|
case 500000:
|
|
case 1000000:
|
|
return __( 'Another order milestone! Take a look at your Orders Report to review your orders to date.', 'woocommerce-admin' );
|
|
default:
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the appropriate note action for a given milestone.
|
|
*
|
|
* @param int $milestone Order milestone.
|
|
* @return array Note actoion (name, label, query) for the milestone.
|
|
*/
|
|
public function get_note_action_for_milestone( $milestone ) {
|
|
switch ( $milestone ) {
|
|
case 1:
|
|
return array(
|
|
'name' => 'learn-more',
|
|
'label' => __( 'Learn more', 'woocommerce-admin' ),
|
|
'query' => 'https://docs.woocommerce.com/document/managing-orders/',
|
|
);
|
|
case 10:
|
|
return array(
|
|
'name' => 'browse',
|
|
'label' => __( 'Browse', 'woocommerce-admin' ),
|
|
'query' => 'https://woocommerce.com/success-stories/',
|
|
);
|
|
case 100:
|
|
case 250:
|
|
case 500:
|
|
case 1000:
|
|
case 5000:
|
|
case 10000:
|
|
case 500000:
|
|
case 1000000:
|
|
return array(
|
|
'name' => 'review-orders',
|
|
'label' => __( 'Review your orders', 'woocommerce-admin' ),
|
|
'query' => '?page=wc-admin#/analytics/orders',
|
|
);
|
|
default:
|
|
return array(
|
|
'name' => '',
|
|
'label' => '',
|
|
'query' => '',
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add milestone notes for other significant thresholds.
|
|
*/
|
|
public function other_milestones() {
|
|
$last_milestone = $this->get_last_milestone();
|
|
$current_milestone = $this->get_current_milestone();
|
|
|
|
if ( $current_milestone <= $last_milestone ) {
|
|
return;
|
|
}
|
|
|
|
$this->set_last_milestone( $current_milestone );
|
|
|
|
// We only want one milestone note at any time.
|
|
WC_Admin_Notes::delete_notes_with_name( self::ORDERS_MILESTONE_NOTE_NAME );
|
|
|
|
// Add the milestone note.
|
|
$note = new WC_Admin_Note();
|
|
$note->set_title( $this->get_note_title_for_milestone( $current_milestone ) );
|
|
$note->set_content( $this->get_note_content_for_milestone( $current_milestone ) );
|
|
$note_action = $this->get_note_action_for_milestone( $current_milestone );
|
|
$note->add_action( $note_action['name'], $note_action['label'], $note_action['query'] );
|
|
$note->set_type( WC_Admin_Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
|
|
$note->set_icon( 'trophy' );
|
|
$note->set_name( self::ORDERS_MILESTONE_NOTE_NAME );
|
|
$note->set_source( 'woocommerce-admin' );
|
|
$note->save();
|
|
}
|
|
}
|
|
|
|
new WC_Admin_Notes_Order_Milestones();
|