settings->get( 'store-credit' ) ) {
return;
}
// Add a "Store Credit & Payout Method" columns to the affiliates admin screen.
add_filter( 'affwp_affiliate_table_columns', array( $this, 'column_store_credit' ), 10, 3 );
add_filter( 'affwp_affiliate_table_store_credit', array( $this, 'column_store_credit_value' ), 10, 2 );
add_filter( 'affwp_affiliate_table_payout_method', array( $this, 'column_payment_method_value' ), 10, 2 );
// Add a "Payout Method" column to the referrals admin screen.
add_filter( 'affwp_referral_table_columns', array( $this, 'referrals_column_store_credit' ), 10, 3 );
add_filter( 'affwp_referral_table_payout_method', array( $this, 'referrals_column_payment_method_value' ), 10, 2 );
// Add the Store Credit Balance to the edit affiliate screen.
add_action( 'affwp_edit_affiliate_end', array( $this, 'edit_affiliate_store_credit_settings' ), 10, 1 );
// WooCommerce-only hooks.
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_edit_affiliate_scripts'] );
add_action( 'wp_ajax_adjust_affiliate_store_credit', [ $this, 'ajax_adjust_affiliate_store_credit'] );
add_action( 'affwp_update_affiliate', array( $this, 'update_affiliate' ), 0 );
}
/**
* (AJAX) Adjust Store Credit for Affiliate.
*
* @since 2.6.0
*/
public function ajax_adjust_affiliate_store_credit() : void {
if ( ! wp_verify_nonce(
filter_input( INPUT_POST, 'nonce', FILTER_UNSAFE_RAW ),
'adjust_affiliate_store_credit'
) ) {
return;
}
if ( ! current_user_can( 'manage_affiliates' ) ) {
wp_send_json( __( 'You are not allowed to change affiliate store credit.', 'affiliatewp-store-credit' ), 200 );
exit;
}
$this->adjust_store_credit(
intval( filter_input( INPUT_POST, 'affiliate_id', FILTER_SANITIZE_NUMBER_INT ) ),
filter_input( INPUT_POST, 'movement', FILTER_UNSAFE_RAW ),
floatval( filter_input( INPUT_POST, 'adjustment', FILTER_UNSAFE_RAW ) )
)
? wp_send_json_success(
floatval(
affwp_store_credit_balance(
[
'user_id' => filter_input( INPUT_POST, 'user_id', FILTER_SANITIZE_NUMBER_INT ),
],
false
)
)
)
: wp_send_json_error( __( "There was an error adjusting the affiliate's store credit, please refresh the page and try again.", 'affiliatewp-store-credit' ) );
exit;
}
/**
* Load Admin CSS for Editing an Affiliate
*
* @since 2.6.0
*/
public function enqueue_edit_affiliate_scripts() : void {
if ( ! $this->is_edit_affiliate_screen() ) {
return;
}
$affiliate = affwp_get_affiliate( filter_input( INPUT_GET, 'affiliate_id', FILTER_SANITIZE_NUMBER_INT ) );
if ( false === $affiliate ) {
return;
}
// CSS.
wp_enqueue_style(
'affiliatewp-store-credit/admin/edit-affiliate',
plugins_url(
'assets/css/admin-edit-affiliate.css',
AFFWP_SC_PLUGIN_FILE
),
[],
AFFWP_SC_VERSION
);
if ( 'woocommerce' !== affiliatewp_store_credit_get_active_integration() ) {
return;
}
// JavaScript.
wp_enqueue_script(
'affiliatewp-store-credit/admin/adjust-store-credit',
plugins_url(
'assets/js/admin-adjust-store-credit.js',
AFFWP_SC_PLUGIN_FILE
),
[
'jquery-core',
'jquery-confirm',
],
AFFWP_SC_VERSION,
true
);
// JavaScript Data.
wp_localize_script(
'affiliatewp-store-credit/admin/adjust-store-credit',
'affiliatewpAdjustAffiliateStoreCredit',
[
'affiliateId' => $affiliate->affiliate_id,
'userId' => $affiliate->user_id,
'currentBalance' => floatval(
affwp_store_credit_balance(
[
'user_id' => $affiliate->user_id,
],
false
)
),
'ajaxURL' => admin_url( 'admin-ajax.php' ),
'ajaxNONCE' => wp_create_nonce( 'adjust_affiliate_store_credit' ),
'currentUserDisplayName' => get_userdata( get_current_user_id() )->display_name ?? __( 'Unknown', 'affiliatewp-store-credit' ),
// From /wp-admin/admin.php?page=affiliate-wp-settings&tab=advanced .
'currency' => [
'symbol' => html_entity_decode( str_replace( '0', '', affwp_currency_filter( 0.00 ) ) ),
'position' => affiliate_wp()->settings->get( 'currency_position', 'before' ),
'thousandsSeparator' => html_entity_decode( affiliate_wp()->settings->get( 'thousands_separator', ',' ) ),
'decimalSeparator' => html_entity_decode( affiliate_wp()->settings->get( 'decimal_separator', '.' ) ),
],
// Translations.
'i18n' => [
'modal' => [
'title' => esc_html__( 'Adjust Store Credit', 'affiliatewp-store-credit' ),
'currentBalance' => esc_html__( 'Current Balance', 'affiliatewp-store-credit' ),
'newBalance' => esc_html__( 'New Balance', 'affiliatewp-store-credit' ),
'increase' => esc_html__( 'Increase Store Credit', 'affiliatewp-store-credit' ),
'decrease' => esc_html__( 'Decrease Store Credit', 'affiliatewp-store-credit' ),
'saveAdjustment' => esc_html__( 'Save Adjustment', 'affiliatewp-store-credit' ),
'manualIncrease' => esc_html__( 'Manual increase', 'affiliatewp-store-credit' ),
'manualDecrease' => esc_html__( 'Manual decrease', 'affiliatewp-store-credit' ),
],
],
]
);
}
/**
* Are we editing an Affiliate?
*
* In the Admin.
*
* @since 2.6.0
*
* @return bool
*/
private function is_edit_affiliate_screen() : bool {
if ( 'affiliate-wp-affiliates' !== filter_input( INPUT_GET, 'page', FILTER_UNSAFE_RAW ) ) {
return false; // Not the affiliate admin screen(s).
}
if ( 'edit_affiliate' !== filter_input( INPUT_GET, 'action', FILTER_UNSAFE_RAW ) ) {
return false; // Not the edit affiliate screen.
}
return true;
}
/**
* Add a "Store Credit & Payment Method" columns to the affiliates screen.
*
* @since 2.2
*
* @param array $prepared_columns Prepared columns.
* @param array $columns The columns for this list table.
* @param object $instance List table instance.
*
* @return array $prepared_columns Prepared columns.
*/
public function column_store_credit( $prepared_columns, $columns, $instance ) {
$offset = 6;
$prepared_columns = array_slice( $prepared_columns, 0, $offset, true ) +
array( 'store_credit' => __( 'Store Credit', 'affiliatewp-store-credit' ) ) +
array( 'payout_method' => __( 'Payout Method', 'affiliatewp-store-credit' ) ) +
array_slice( $prepared_columns, $offset, null, true );
return $prepared_columns;
}
/**
* Show the store credit balance for each affiliate.
*
* @since 2.2
*
* @param string $value The column data.
* @param object $affiliate The current affiliate object.
*
* @return string $value The affiliate's store credit balance.
*/
public function column_store_credit_value( $value, $affiliate ) {
$value = affwp_store_credit_balance( array( 'affiliate_id' => $affiliate->affiliate_id ) );
return $value;
}
/**
* Show the payment method for each affiliate.
*
* @since 2.3
*
* @param string $value The column data.
* @param object $affiliate The current affiliate object.
*
* @return string $value The affiliate's payment method.
*/
public function column_payment_method_value( $value, $affiliate ) {
$value = $this->get_payout_method( $affiliate->affiliate_id );
return $value;
}
/**
* Adds a "Payment Method" column to the referrals screen.
*
* @since 2.3.4
*
* @param array $prepared_columns Prepared columns.
* @param array $columns The columns for this list table.
* @param object $instance List table instance.
* @return array Prepared columns.
*/
public function referrals_column_store_credit( $prepared_columns, $columns, $instance ) {
$offset = 8;
$prepared_columns = array_slice( $prepared_columns, 0, $offset, true ) +
array( 'payout_method' => __( 'Payout Method', 'affiliatewp-store-credit' ) ) +
array_slice( $prepared_columns, $offset, null, true );
return $prepared_columns;
}
/**
* Shows the payment method for each referral.
*
* @since 2.3.4
*
* @param string $value The column data.
* @param object $affiliate The current affiliate object.
* @return string The affiliate's payment method.
*/
public function referrals_column_payment_method_value( $value, $referral ) {
$value = $this->get_payout_method( $referral->affiliate_id );
return $value;
}
/**
* Display the store credit settings.
*
* @access public
* @param \AffWP\Affiliate $affiliate The affiliate object being edited.
*
* @since 2.2
*/
public function edit_affiliate_store_credit_settings( $affiliate ) {
$integration = affiliatewp_store_credit_get_active_integration();
$balance = affwp_store_credit_balance( [ 'affiliate_id' => $affiliate->affiliate_id ] );
$checked = affwp_get_affiliate_meta( $affiliate->affiliate_id, 'store_credit_enabled', true );
$transactions = affiliatewp_store_credit()->transactions->get_transactions_for_user( $affiliate->user_id );
?>
settings->get( 'store-credit-all-affiliates' ) ) : ?>
integrations->get_enabled_integrations() );
if (
! in_array( 'woocommerce', $enabled_integrations, true )
&& ! in_array( 'edd', $enabled_integrations, true )
) {
return $tabs;
}
$tabs['store-credit'] = __( 'Store Credit', 'affiliatewp-store-credit' );
return $tabs;
}
/**
* Add our settings
*
* @access public
* @since 2.0.0
* @param array $settings The existing settings
* @return array $settings The updated settings
*/
public function register_settings( $settings = array() ) {
$settings[ 'store-credit' ] = array(
'store-credit' => array(
'name' => __( 'Enable Store Credit', 'affiliatewp-store-credit' ),
'desc' => __( 'Check this box to enable store credit for referrals.', 'affiliatewp-store-credit' ),
'type' => 'checkbox'
),
'store-credit-all-affiliates' => array(
'name' => __( 'Enable For All Affiliates?', 'affiliatewp-store-credit' ),
'desc' => __( 'Check this box to allow all affiliates to receive store credit.', 'affiliatewp-store-credit' ),
'type' => 'checkbox'
),
'store-credit-change-payment-method' => array(
'name' => __( 'Enable Store Credit Opt-In', 'affiliatewp-store-credit' ),
'desc' => __( 'Check this box to allow affiliates to enable payout via store credit from their affiliate dashboard.', 'affiliatewp-store-credit' ),
'type' => 'checkbox',
),
);
if ( class_exists( 'WC_Subscriptions' ) ) {
$settings['store-credit']['store-credit-woocommerce-subscriptions'] = array(
'name' => __( 'Apply Store Credit To WooCommerce Subscriptions Renewal Orders', 'affiliatewp-store-credit' ),
'desc' => __( 'Check this box to automatically apply the affiliate store credit to WooCommerce Subscriptions renewal orders.', 'affiliatewp-store-credit' ),
'type' => 'checkbox',
);
}
return $settings;
}
/**
* Save affiliate store credit option in the affiliate meta table.
*
* @since 2.3
*/
public function update_affiliate( $data ) {
if ( empty( $data['affiliate_id'] ) ) {
return false;
}
if ( ! current_user_can( 'manage_affiliates' ) ) {
return;
}
$enable_store_credit = isset( $data['enable_store_credit'] ) ? $data['enable_store_credit'] : '';
if ( $enable_store_credit ) {
affwp_update_affiliate_meta( $data['affiliate_id'], 'store_credit_enabled', $enable_store_credit );
} else {
affwp_delete_affiliate_meta( $data['affiliate_id'], 'store_credit_enabled' );
}
}
/**
* Adjust Store Credit
*
* When we save the affiliate data, we adjust the store credit balance if there
* is a movement and amount specified.
*
* @since 2.6.0
*
* @param int $affiliate_id The Affiliate (ID).
* @param string $movement The movement, either `increase` or `decrease`.
* @param float $amount The amount to increase or decrease by.
*
* @return bool True if it was updated, false if not.
*/
private function adjust_store_credit(
int $affiliate_id,
string $movement,
float $amount
) : bool {
if ( ! in_array( $movement, [ 'increase', 'decrease' ], true ) ) {
return false;
}
if ( $amount <= 0 ) {
return false;
}
if ( $affiliate_id <= 0 ) {
return false;
}
if ( ! class_exists( 'AffiliateWP_Store_Credit_WooCommerce' ) ) {
return false; // Store credit not active.
}
$affiliate = affwp_get_Affiliate( $affiliate_id );
if ( ! is_a( $affiliate, '\AffWP\Affiliate' ) ) {
return false;
}
try {
$adjustment = AffiliateWP_Store_Credit_WooCommerce::adjust_store_credit(
$movement,
$amount,
$affiliate->user_id,
'manual',
$affiliate->affiliate_id,
__METHOD__,
get_current_user_id(), // The user who is making the adjustment.
);
return is_numeric( $adjustment )
|| true === $adjustment;
} catch ( Exception $e ) {
affiliate_wp()->utils->log(
"Store credit adjustment failed for affiliate with ID #{$affiliate_id} with error: {$e->getMessage()}"
);
return false;
}
}
/**
* Get the payment method set for the affiliate.
*
* @since 2.3
*
* @param int $affiliate_id The affiliate ID
*
* @return string $payment method The payment method set for the affiliate
*/
public function get_payout_method( $affiliate_id = 0 ) {
$payment_method = __( 'Cash', 'affiliatewp-store-credit' );
$global_store_credit_enabled = affiliate_wp()->settings->get( 'store-credit-all-affiliates' );
if ( $global_store_credit_enabled ) {
$payment_method = __( 'Store Credit', 'affiliatewp-store-credit' );
} else {
$affiliate_store_credit_enabled = affwp_get_affiliate_meta( $affiliate_id, 'store_credit_enabled', true );
if ( $affiliate_store_credit_enabled ) {
$payment_method = __( 'Store Credit', 'affiliatewp-store-credit' );
}
}
return $payment_method;
}
}
new AffiliateWP_Store_Credit_Admin;