Top ↑

Methods #Methods

• __construct — Setup the EDD Payments class
• __get — Magic GET function
• __isset — Magic ISSET function, which allows empty checks on protected elements
• __set — Magic SET function
• add_download — Add a download to a given payment
• add_fee — Add a fee to a given payment
• add_meta — Add an item to the payment meta
• add_note — Add a note to a payment
• array_convert — Converts this ojbect into an array for special cases
• decrease_fees — Decrease the payment's subtotal
• decrease_subtotal — Decrease the payment's subtotal
• decrease_tax — Decrease the payment's tax by the provided amount
• delete_meta — Delete an item from payment meta
• delete_sales_logs — Delete sales logs for this purchase
• get_address — Retrieve payment billing address
• get_cart_details — Retrieve payment cart details
• get_completed_date — Retrieve payment completion date
• get_currency — Retrieve payment currency
• get_customer_id — Retrieve payment customer ID
• get_discounted_amount — Return the discounted amount of the payment.
• get_discounts — Retrieve payment discounts
• get_downloads — Retrieve downloads on payment
• get_email — Retrieve payment email
• get_fees — Get the fees, filterable by type
• get_gateway — Retrieve payment gateway
• get_ip — Retrieve payment IP
• get_key — Retrieve payment key
• get_meta — Get a post meta item for the payment
• get_number — Retrieve payment number
• get_recovery_url — Returns the URL that a customer can use to resume a payment, or false if it's not recoverable.
• get_subtotal — Retrieve payment subtotal
• get_tax — Retrieve payment tax
• get_transaction_id — Retrieve payment transaction ID
• get_unlimited — Retrieve unlimited file downloads status
• get_user_id — Retrieve payment user ID
• get_user_info — Retrieve payment user info
• in_process — Easily determine if the payment is in a status of pending some action. Processing is specifically used for eChecks.
• increase_fees — Increase the payment's subtotal
• increase_subtotal — Increase the payment's subtotal
• increase_tax — Increase the payment's tax by the provided amount
• insert_payment — Create the base of a payment.
• is_recoverable — Determines if this payment is able to be resumed by the user.
• maybe_alter_stats — Used during the process of moving to refunded or pending, to decrement stats
• maybe_create_customer — Determines if a customer needs to be created given the current payment details.
• modify_cart_item — Alter a limited set of properties of a cart item
• process_failure — Process when a payment is set to failed, decrement discount usages and other stats
• process_pending — Process when a payment moves to pending
• process_refund — When a payment is set to a status of 'refunded' process the necessary actions to reduce stats
• recalculate_total — Set or update the total for a payment
• refund — Change the status of the payment to refunded, and run the necessary changes
• remove_download — Remove a download from the payment
• remove_fee — Remove a fee from the payment
• remove_fee_by — Remove a fee by the defined attributed
• save — One items have been set, an update is needed to save them to the database.
• setup_address — Setup the Address for the payment
• setup_cart_details — Setup the cart details
• setup_completed_date — Setup the payment completed date
• setup_currency — Setup the currency code
• setup_customer_id — Setup the customer ID
• setup_discounts — Setup the payments discount codes
• setup_downloads — Setup the downloads array
• setup_email — Setup the email address for the purchase
• setup_fees — Setup any fees associated with the payment
• setup_fees_total — Setup the payment fees
• setup_gateway — Setup the gateway used for the payment
• setup_has_unlimited — Setup the Unlimited downloads setting
• setup_ip — Setup the IP Address for the payment
• setup_mode — Setup the payment mode
• setup_payment — Setup payment properties
• setup_payment_key — Setup the payment key
• setup_payment_number — Setup the payment number
• setup_subtotal — Setup the payment subtotal
• setup_tax — Setup the payment tax
• setup_tax_rate — Setup the payment tax rate
• setup_total — Setup the payment total
• setup_transaction_id — Setup the transaction ID
• setup_user_id — Setup the User ID associated with the purchase
• setup_user_info — Setup the user info
• update_meta — Update the post meta
• update_status — Set the payment status and run any status specific changes necessary