ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / dansact.com / wp-content / plugins / wp-webhooks / core / includes / integrations / edd / actions

<?php
if ( ! class_exists( 'WP_Webhooks_Integrations_edd_Actions_edd_delete_payment' ) ) :

/**
	 * Load the edd_delete_payment action
	 *
	 * @since 4.2.0
	 * @author Ironikus <info@ironikus.com>
	 */
	class WP_Webhooks_Integrations_edd_Actions_edd_delete_payment {

public function is_active(){

$is_active = true;

//Backwards compatibility for the "Easy Digital Downloads" integration
            if( defined( 'WPWH_EDD_NAME' ) ){
                $is_active = false;
            }

return $is_active;
        }

public function get_details(){

$translation_ident = "action-edd_delete_payment-description";

$parameter = array(
				'payment_id'       => array( 'required' => true, 'short_description' => WPWHPRO()->helpers->translate( '(Integer) The id of the payment you want to update.', $translation_ident ) ),
				'update_customer_stats'    => array( 'short_description' => WPWHPRO()->helpers->translate( '(String) Set this value to "yes" to update the statistics of the customer. Default: no', $translation_ident ) ),
				'delete_download_logs'    => array( 'short_description' => WPWHPRO()->helpers->translate( '(String)  Set this value to "yes" to delete the payment including all its related download logs. Default: no', $translation_ident ) ),
				'do_action'     => array( 'short_description' => WPWHPRO()->helpers->translate( 'Advanced: Register a custom action after WP Webhooks fires this webhook. More infos are in the description.', $translation_ident ) ),
			);

//This is a more detailled view of how the data you sent will be returned.
			$returns = array(
				'success'        => array( 'short_description' => WPWHPRO()->helpers->translate( '(Bool) True if the action was successful, false if not. E.g. array( \'success\' => true )', $translation_ident ) ),
				'msg'        => array( 'short_description' => WPWHPRO()->helpers->translate( '(string) A message with more information about the current request. E.g. array( \'msg\' => "This action was successful." )', $translation_ident ) ),
				'data'        => array( 'short_description' => WPWHPRO()->helpers->translate( '(array) Within the data array, you will find further details about the response, as well as the payment id and further information.', $translation_ident ) ),
			);

$returns_code = array (
				'success' => true,
				'msg' => 'The payment was successfully deleted.',
				'data' => 
				array (
				  'payment_id' => 747,
				),
			);

ob_start();
?>
<?php echo WPWHPRO()->helpers->translate( "This webhook action is used to delete a payment for Easy Digital Downloads within your WordPress system via a webhook call.", $translation_ident ); ?>
<br>
<?php echo WPWHPRO()->helpers->translate( "The description is uniquely made for the <strong>edd_delete_payment</strong> webhook action.", $translation_ident ); ?>
<br>
<?php echo WPWHPRO()->helpers->translate( "In case you want to first understand how to setup webhook actions in general, please check out the following manuals:", $translation_ident ); ?>
<br>
<a title="Go to wp-webhooks.com/docs" target="_blank" href="https://wp-webhooks.com/docs/article-categories/get-started/">https://wp-webhooks.com/docs/article-categories/get-started/</a>
<br><br>
<h4><?php echo WPWHPRO()->helpers->translate( "How to use <strong>edd_delete_payment</strong>", $translation_ident ); ?></h4>
<ol>
    <li><?php echo WPWHPRO()->helpers->translate( "The first argument you need to set within your webhook action request is the <strong>action</strong> argument. This argument is always required. Please set it to <strong>edd_delete_payment</strong>.", $translation_ident ); ?></li>
    <li><?php echo WPWHPRO()->helpers->translate( "It is also required to set the <strong>payment_id</strong> argument. Please set the id of the payment you want to delete.", $translation_ident ); ?></li>
    <li><?php echo WPWHPRO()->helpers->translate( "All the other arguments are optional and just extend the creation of the EDD payment.", $translation_ident ); ?></li>
</ol>
<br><br>
<h4><?php echo WPWHPRO()->helpers->translate( "Tipps", $translation_ident ); ?></h4>
<ol>
    <li><?php echo WPWHPRO()->helpers->translate( "By default, we do not update the statistics of the user (lifetime value, etc). To recalculate the statustics, please set the <strong>update_customer_stats</strong> argument to 'yes'.", $translation_ident ); ?></li>
    <li><?php echo WPWHPRO()->helpers->translate( "You can also delete all the download logs of the payment using the <strong>delete_download_logs</strong> argument. Set it to <strong>yes</strong> to delete them too.", $translation_ident ); ?></li>
</ol>
<br><br>
<h4><?php echo WPWHPRO()->helpers->translate( "Special Arguments", $translation_ident ); ?></h4>
<br>

<h5><?php echo WPWHPRO()->helpers->translate( "update_customer_stats", $translation_ident ); ?></h5>
<?php echo WPWHPRO()->helpers->translate( "Set this value to <strong>yes</strong> to decrease the purchase count, as well as the total value.", $translation_ident ); ?>
<br>
<hr>

<h5><?php echo WPWHPRO()->helpers->translate( "delete_download_logs", $translation_ident ); ?></h5>
<?php echo WPWHPRO()->helpers->translate( "This argument can remove all download logs that are related to the payment id. To delete the logs, simply set the argument value to <strong>yes</strong>", $translation_ident ); ?>
<br>
<hr>

<h5><?php echo WPWHPRO()->helpers->translate( "do_action", $translation_ident ); ?></h5>
<?php echo WPWHPRO()->helpers->translate( "The do_action argument is an advanced webhook for developers. It allows you to fire a custom WordPress hook after the <strong>edd_delete_payment</strong> action was fired.", $translation_ident ); ?>
<br>
<?php echo WPWHPRO()->helpers->translate( "You can use it to trigger further logic after the webhook action. Here's an example:", $translation_ident ); ?>
<br>
<br>
<?php echo WPWHPRO()->helpers->translate( "Let's assume you set for the <strong>do_action</strong> parameter <strong>fire_this_function</strong>. In this case, we will trigger an action with the hook name <strong>fire_this_function</strong>. Here's how the code would look in this case:", $translation_ident ); ?>
<pre>add_action( 'fire_this_function', 'my_custom_callback_function', 20, 2 );
function my_custom_callback_function( $payment_id, $return_args ){
    //run your custom logic in here
}
</pre>
<?php echo WPWHPRO()->helpers->translate( "Here's an explanation to each of the variables that are sent over within the custom function.", $translation_ident ); ?>
<ol>
    <li>
        <strong>$payment_id</strong> (array)
        <br>
        <?php echo WPWHPRO()->helpers->translate( "Contains the id of the newly deleted payment.", $translation_ident ); ?>
    </li>
    <li>
        <strong>$return_args</strong> (array)
        <br>
        <?php echo WPWHPRO()->helpers->translate( "An array containing the information we will send back as the response to the initial webhook caller.", $translation_ident ); ?>
    </li>
</ol>
<?php
			$description = ob_get_clean();

return array(
                'action'            => 'edd_delete_payment',
                'name'              => WPWHPRO()->helpers->translate( 'Delete payment', $translation_ident ),
                'sentence'              => WPWHPRO()->helpers->translate( 'delete a payment', $translation_ident ),
                'parameter'         => $parameter,
                'returns'           => $returns,
                'returns_code'      => $returns_code,
                'short_description' => WPWHPRO()->helpers->translate( 'This webhook action allows you to delete a payment within Easy Digital Downloads.', $translation_ident ),
                'description'       => $description,
                'integration'       => 'edd',
                'premium' 			=> false,
            );

}

public function execute( $return_data, $response_body ){

$return_args = array(
				'success' => false,
				'msg' => '',
				'data' => array(),
			);

$payment_id     = intval( WPWHPRO()->helpers->validate_request_value( $response_body['content'], 'payment_id' ) );
			$update_customer_stats     	= ( WPWHPRO()->helpers->validate_request_value( $response_body['content'], 'update_customer_stats' ) === 'yes' ) ? true : false;
			$delete_download_logs   = ( WPWHPRO()->helpers->validate_request_value( $response_body['content'], 'delete_download_logs' ) === 'yes' ) ? true : false;
			
			$do_action          = WPWHPRO()->helpers->validate_request_value( $response_body['content'], 'do_action' );

if( empty( $payment_id ) ){
				$return_args['msg'] = WPWHPRO()->helpers->translate( 'Payment not deleted. The argument payment_id cannot be empty.', 'action-edd_delete_payment-failure' );
	
				return $return_args;
			}

$payment_exists = edd_get_payment_by( 'id', $payment_id );

if( empty( $payment_exists ) ){
				$return_args['msg'] = WPWHPRO()->helpers->translate( 'The payment id you tried to delete, could not be fetched.', 'action-edd_delete_payment-failure' );
	
				return $return_args;
			}

$return_args['data']['payment_id'] = $payment_id;
			$return_args['data']['update_customer'] = $update_customer_stats;
			$return_args['data']['delete_download_logs'] = $delete_download_logs;

edd_delete_purchase( $payment_id, $update_customer_stats, $delete_download_logs ); //void function
			$return_args['success'] = true;
			$return_args['msg'] = WPWHPRO()->helpers->translate( "The payment was successfully deleted.", 'action-edd_delete_payment-success' );

if( ! empty( $do_action ) ){
				do_action( $do_action, $payment_id, $return_args );
			}

return $return_args;
            
        }

}

endif; // End if class_exists check.

[-] edd_update_download.php [edit]
[-] edd_create_customer.php [edit]
[-] edd_renew_license.php [edit]
[-] edd_delete_customer.php [edit]
[-] edd_delete_subscription.php [edit]
[-] edd_delete_payment.php [edit]
[-] index.php [edit]
[-] edd_create_subscription.php [edit]
[+] ..
[-] edd_delete_discount.php [edit]
[-] edd_update_customer.php [edit]
[-] edd_update_payment.php [edit]
[-] edd_create_discount.php [edit]
[-] edd_create_download.php [edit]
[-] edd_update_license.php [edit]
[-] edd_delete_download.php [edit]
[-] edd_create_payment.php [edit]
[-] edd_update_discount.php [edit]
[-] edd_delete_license.php [edit]
[-] edd_create_license.php [edit]
[-] edd_update_subscription.php [edit]