Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update the param type to include EDD\Orders\Order #9730

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update the param type to include EDD\Orders\Order #9730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions includes/download-functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1189,11 +1189,11 @@ function edd_get_file_price_condition( $download_id = 0, $file_key = '' ) {
* @since 1.0
* @since 3.0 Updated to use new query methods.
*
* @param string $order_or_key The order object or payment key. Using the payment key will eventually be deprecated.
* @param string $email Customer email address. Use edd_get_payment_user_email() to get user email.
* @param int $filekey Index of array of files returned by edd_get_download_files() that this download link is for.
* @param int $download_id Optional. ID of download this download link is for. Default is 0.
* @param bool|int $price_id Optional. Price ID when using variable prices. Default is false.
* @param string|\EDD\Orders\Order $order_or_key The order object or payment key. Using the payment key will eventually be deprecated.
* @param string $email Customer email address. Use edd_get_payment_user_email() to get user email.
* @param int $filekey Index of array of files returned by edd_get_download_files() that this download link is for.
* @param int $download_id Optional. ID of download this download link is for. Default is 0.
* @param bool|int $price_id Optional. Price ID when using variable prices. Default is false.
*
* @return string Secure download URL.
*/
Expand Down
2 changes: 1 addition & 1 deletion includes/misc-functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1081,7 +1081,7 @@ function edd_set_upload_dir( $upload ) {
/**
* Determines the receipt visibility status
*
* @param string $order_or_key The order object or payment key. Using the payment key will eventually be deprecated.
* @param string|\EDD\Orders\Order $order_or_key The order object or payment key. Using the payment key will eventually be deprecated.
* @return bool whether the receipt is visible or not.
*/
function edd_can_view_receipt( $order_or_key = '' ) {
Expand Down
30 changes: 15 additions & 15 deletions includes/payments/functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,7 +850,7 @@ function edd_get_payment_meta_cart_details( $payment_id, $include_bundle_files =
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return string $email User email.
*/
function edd_get_payment_user_email( $order = 0 ) {
Expand All @@ -876,7 +876,7 @@ function edd_get_payment_user_email( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return bool True if the payment is **not** associated with a user, false otherwise.
*/
function edd_is_guest_payment( $order = 0 ) {
Expand Down Expand Up @@ -904,7 +904,7 @@ function edd_is_guest_payment( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return string $user_id User ID.
*/
function edd_get_payment_user_id( $order = 0 ) {
Expand All @@ -930,7 +930,7 @@ function edd_get_payment_user_id( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return int $customer_id Customer ID.
*/
function edd_get_payment_customer_id( $order = 0 ) {
Expand All @@ -956,7 +956,7 @@ function edd_get_payment_customer_id( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return bool True if the payment has unlimited downloads, false otherwise.
*/
function edd_payment_has_unlimited_downloads( $order = 0 ) {
Expand All @@ -982,7 +982,7 @@ function edd_payment_has_unlimited_downloads( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return string User's IP address.
*/
function edd_get_payment_user_ip( $order = 0 ) {
Expand Down Expand Up @@ -1022,7 +1022,7 @@ function edd_get_payment_completed_date( $order_id = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return string Payment gateway used for the order.
*/
function edd_get_payment_gateway( $order = 0 ) {
Expand All @@ -1048,7 +1048,7 @@ function edd_get_payment_gateway( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return string $currency The currency code
*/
function edd_get_payment_currency_code( $order = 0 ) {
Expand Down Expand Up @@ -1097,7 +1097,7 @@ function edd_get_payment_currency( $order_id = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return string $key Purchase key.
*/
function edd_get_payment_key( $order = 0 ) {
Expand Down Expand Up @@ -1125,7 +1125,7 @@ function edd_get_payment_key( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return int|string Payment order number.
*/
function edd_get_payment_number( $order = 0 ) {
Expand Down Expand Up @@ -1182,7 +1182,7 @@ function edd_remove_payment_prefix_postfix( $number ) {
* @since 3.0 Parameter renamed to $order_id.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
*
* @return string $amount Fully formatted payment amount
*/
Expand All @@ -1201,7 +1201,7 @@ function edd_payment_amount( $order = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return float Order amount.
*/
function edd_get_payment_amount( $order = 0 ) {
Expand Down Expand Up @@ -1239,7 +1239,7 @@ function edd_get_payment_amount( $order = 0 ) {
* @since 3.0 Parameter renamed to $order_id.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order_id Order ID.
* @param int|\EDD\Orders\Order $order_id Order ID or the EDD\Orders\Order object.
*
* @return string Fully formatted order subtotal.
*/
Expand All @@ -1257,7 +1257,7 @@ function edd_payment_subtotal( $order_id = 0 ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @return float $subtotal Subtotal for the order (non formatted).
*/
function edd_get_payment_subtotal( $order = 0 ) {
Expand Down Expand Up @@ -1301,7 +1301,7 @@ function edd_payment_tax( $order_id = 0, $payment_meta = null ) {
* @since 3.0 Refactored to use EDD\Orders\Order.
* @since 3.1.1 Allows passing a full EDD\Orders\Order object in, instead of just the ID
*
* @param int $order Order ID or the EDD\Orders\Order object
* @param int|\EDD\Orders\Order $order Order ID or the EDD\Orders\Order object
* @param bool $payment_meta Parameter no longer used.
*
* @return float $tax Tax for payment (non formatted)
Expand Down