Filters

includes/admin/class-yith-ywgc-backend-extended.php

Filter the condition to generate the gift card. Useful to third-party plugins

Params
 bool true to generate the gift card in the order, false for not
 object $order the order object

Return
 bool

---

Filter the condition to apply a race condition when generating the gift cards in the order. Useful when having issues with duplicated gift card codes

Params
 bool true to apply it, false for not

Return
 bool

---

Filter the condition to generate the gift card by order item

Params
 bool true to generate it, false for not
 object $order the order object
 int $order_item_id the order item ID
 array $order_item_data the order item data

Return
 bool

---

Filter the line subtotal when generating a gift card code

Params
 float the line subtotal
 array $order_item_data the order item data
 int $order_id the order ID
 int $order_item_id the order item ID

Return
 bool

---

Filter the line subtotal tax when generating a gift card code

Params
 float the line subtotal tax
 array $order_item_data the order item data
 int $order_id the order ID
 int $order_item_id the order item ID

Return
 bool

---

Filter the gift card recipients on gift card creation

Params
 array the recipients

Return
 array

---

Filter the if the gift card is postdated

Params
 bool true if is postdated, false if not

Return
 bool

---

Filter the customer as the gift card recipient using the billing email

Params
 string the recipient email

Return
 string

---

Filter the generated gift card code

Params
 string the gift card code
 object $order the order object
 object $gift_card the gift card object

Return
 string

---

Filter the gift card usage expiration in months

Params
 string the usage expiration in months
 object $gift_card the gift card object
 int $product_id the product ID

Return
 string

---

Filter the condition to send the gift card code

Params
 bool true to send it, false for not. Default: true
 object $gift_card the gift card object

Return
 bool

---

Filter the condition to send the gift card code to a custom recipient

Params
 bool true to send it, false for not. Default: false
 object $gift_card the gift card object

Return
 bool

---

Filter the URL of the ajax loader gif for the plugin

Params
 string the gif URL

Return
 string

---

includes/admin/class-yith-ywgc-backend.php

Filter the order statuses where the gift card will be generated

Params
 array the order statuses. Default: 'completed', 'processing'

Return
 array

---

Filter the condition to generate the gift card when the order is completed

Params
 bool true to generate it when the order is completed, false for not
 object $order the order object

Return
 bool

---

Filter the gift card table classes

Params
 array $classes the table classes
 int $post_id the post ID

Return
 array

---

Filter the gift card amount applied to the order

Params
 string the amount applied to the order
 object the gift card object

Return
 string

---

Filter the condition to restore the gift card amount if the order is refunded or cancelled

Params
 bool true to restore the amount, false for not. Default: true
 object $gift_card the gift card object

Return
 bool

---

includes/admin/class-ywgc-admin-extended.php

Filter the plugin settings capability

Params
 string the capability name. Default: manage_options

Return
 string

---

includes/admin/post-types/class-yith-ywgc-gift-card-post-type-admin.php

Filter the column names in the gift cards dashboard

Params
 array $columns array of columns titles

Return
 array

---

Filter the "Generated in bulk" string in the gift cards dashboard

Params
 string the "Generated in bulk" string

Return
 string

---

Filter the "Created manually" string in the gift cards dashboard

Params
 string the "Created manually" string

Return
 string

---

Filter the gift card balance in the gift cards dashboard

Params
 string the gift card balance using the wc_price method
 object $gift_card the gift card object

Return
 string

---

Filter the "The code has not been used yet" string in the gift cards dashboard

Params
 string the "The code has not been used yet" string

Return
 string

---

Filter the default column in the gift cards dashboard

Params
 string the column data
 int $post_ID the gift card ID
 string $column_name the column name

Return
 string

---

includes/class-yith-wc-product-gift-card.php

Filter the gift card amounts

Params
 string $amounts_to_show gift card amounts
 object $this  gift card object

Return
 array

---

Filter the gift card product instance

Params
 object $this gift card product instance

Return
 object

---

Filter the empty price HTML for the gift cards

Params
 string empty string
 object $this gift card product instance

Return
 string

---

Filter the price range of a gift card product

Params
 string $price price range of the gift card
 object $this gift card product instance
 string $min_price minimum amount of the gift card
 string $max_price maximum amount of the gift card

Return
 string

---

Filter the gift card amounts to be shown

Params
 string $amounts_to_show gift card amounts to show
 string $gift_card_product_id  gift card product id

Return
 array

---

Filter the gift card amounts by currency

Params
 string $amounts_to_show gift card amounts
 object $this  gift card object
 int $currency_id  currency ID

Return
 array

---

Filter the manual amount status for the gift card product

Params
 bool bool to check if the manual amount is enabled
 bool $status manual amount status
 object $this gift card product instance

Return
 bool

---

Filter the "Select amount" text for the gift card products on the catalog pages

Params
 string $text Select amount text

Return
 string

---

Filter the WooCommerce add to cart button text for the gift card products, using the gift card object on the second param

Params
 string $text add to cart text
 string $this gift card object

Return
 string

---

includes/class-yith-woocommerce-gift-cards-extended.php

Filter the fields to show when editing a gift card on backend

Params
 array array with the fields to display

Return
 array

---

Filter the random generation of the gift card code

Params
 string the code randomly generated

Return
 string

---

includes/class-yith-woocommerce-gift-cards.php

Filter to show or not the gift card dashboard in the WordPress menu

Params
 bool true to show it, false to hide it

Return
 bool

---

Filter if current user can create a gift card

Params
 bool true if the current user can create a gift card, false if not

Return
 bool

---

Filter the random generation of the gift card code

Params
 string the code randomly generated

Return
 string

---

Params
 array $emails List of email types

Return
 array

---

Filter the condition to deny or not the usage of gift cards codes to purchase gift card products

Params
 bool true to deny it, false for not. Default: false

Return
 bool

---

Filter if the gift card have errors when applying it

Params
 string $err_code the error code
 object $gift the gift card object

Return
 string

---

Filter the condition to allow to apply the gift card codes to WC_Subscriptions_Product products in the cart

Params
 bool true to now allow it and display an error in the cart, false to allow it. Default: true

Return
 bool

---

Filter the gift card code response when applied to the cart. It allows to add conditions based on the products in the cart

Params
 bool true to apply the gift card code, false to not
 object $gift the gift card applied object

Return
 bool

---

includes/class-yith-ywgc-cart-checkout-extended.php

Filter the delivery date in the cart item data

Params
 string the delivery date including the gmt_offset
 string $delivery_date the delivery date

Return
 string

---

includes/class-yith-ywgc-cart-checkout.php

Filter the condition to verify the coupon code

Params
 bool true to add a condition, false for not. Default: false
 array $return_val the returning value of the coupon
 string $code the gift card code applied as coupon

Return
 bool

---

Filter the gift card balance to apply it as a coupon

Params
 float the gift card balance
 object $gift_card the gift card object

Return
 float

---

Filter the temporal coupon data, generated with the gift card data

Params
 array the temporal coupon data
 object $gift_card the gift card object

Return
 array

---

Filter the condition to override the cart item taxes when allowing the shipping in coupons

Params
 bool true to allow it, false for not. Default: true

Return
 bool

---

Filter the gift card product image in the cart

Params
 string $product_image the product image
 array $cart_item the cart item

Return
 string

---

Filter the gift card amount in the "Thank you" page

Params
 string $amount the gift card amount
 object the gift card object

Return
 string

---

Filter the gift card applied message in the order totals

Params
 string the applied gift card message
 string $amount the gift card amount
 string $code the gift card code

Return
 string

---

Filter the gift card displayed on the totals

Params
 array $total_rows the gift card data displayed on the totals
 string $code the gift card code

Return
 array

---

Filter the gift card label in the totals on cart

Params
 string the gift card label
 string $code the gift card code

Return
 string

---

Filter the gift card total amount in the totals on cart

Params
 string $amount the gift card amount
 string $code the gift card code

Return
 string

---

Filter the "remove" text displayed on the cart totals, to remove the gift card from the cart

Params
 string the "remove" text

Return
 string

---

Filter the gift card balance to be applied to the cart

Params
 string the gift card balance
 object $gift_card the gift card object

Return
 string

---

Filter the condition to detract the gift card balance residue to the shipping total

Params
 bool true to allow it, false for not. Default: true

Return
 bool

---

Filter the condition to recalculate taxes after cart total

Params
 bool true to recalculate it, false for not. Default: false

Return
 bool

---

Filter the gift card amount before deduct it from the gift card balance

Params
 string $amount the amount to be deducted
 object $gift the gift card object

Return
 string

---

Filter the gift card new balance before update it

Params
 string the new gift card balance
 object $gift the gift card object
 string $amount the amount to be deducted

Return
 string

---

Filter the gift card item price in the cart session

Params
 float the gift card amount
 array $values array with the values

Return
 float

---

includes/class-yith-ywgc-emails-extended.php

Filter the send date for the delayed gift cards

Params
 int the send date in timestamp

Return
 int

---

Filter the condition to deny to send the gift card email

Params
 bool true to deny it, false to allow it. Default: false
 object $gift_card the gift card object

Return
 bool

---

Filter the recipient email before sending the gift card email

Params
 string the recipient email
 object $gift_card the gift card object

Return
 string

---

includes/class-yith-ywgc-emails.php

Filter the condition to deny to send the gift card email

Params
 bool true to deny it, false to allow it. Default: false
 object $gift_card the gift card object

Return
 bool

---

Filter the recipient email before sending the gift card email

Params
 string the recipient email
 object $gift_card the gift card object

Return
 string

---

Filter the introductory text in the gift card email

Params
 string $text introductory text
 object $gift_card the gift card object

Return
 string

---

Filter the shop name displayed on the gift card email footer

Params
 string the shop name

Return
 string

---

Filter the shop link displayed on the gift card email footer

Params
 string the shop link. Default: shop page

Return
 string

---

includes/class-yith-ywgc-frontend-extended.php

Filter the cart hook where we want to display the fields to add the gift card codes

Params
 string the hook name. Default: woocommerce_before_cart

Return
 string

---

Filter the checkout hook where we want to display the fields to add the gift card codes

Params
 string the hook name. Default: woocommerce_before_checkout_form

Return
 string

---

includes/class-yith-ywgc-frontend.php

Filter the "Gift Cards" menu item title on "My Account"

Params
 string the "Gift Cards" menu item title

Return
 string

---

Filter the condition to display the gift card code in the order details

Params
 bool true to display it, false to not. Default: true

Return
 bool

---

Filter the condition to enqueue of the frontend scripts

Params
 bool true to enqueue the scripts everywhere. False to only enqueue them in the product, cart and checkout pages.

Return
 bool

---

Filter the gift card notices target in the frontend script

Params
 string the notice target selector. Default: div.woocommerce

Return
 string

---

Filter the empty price HTML for the gift cards

Params
 string empty string
 object $this gift card product instance

Return
 string

---

Filter the price range of a gift card product

Params
 string $price_html price range of the gift card
 object $this gift card product instance
 float $min_price minimum amount of the gift card
 float $max_price maximum amount of the gift card

Return
 string

---

includes/class-yith-ywgc-gift-card.php

Filter the gift card post title

Params
 string the post title
 object $post the gift card post object

Return
 object

---

Filter the gift card total balance on post creation

Params
 float the total balance
 object $post the gift card post object
 string the gift card code

Return
 float

---

Filter the condition to check if the gift card can be used

Params
 bool $can_use true if it can be used, false if not
 object the gift card object

Return
 bool

---

Filter the gift card total balance getter

Params
 float the total balance rounded
 float the total balance
 object the gift card post object

Return
 float

---

Filter the gift card error message

Params
 string $err the error message
 string $err_code the error code
 object the gift card object

Return
 string

---

Filter the error message when a gift card is applied to the cart

Params
 string $err the error message
 string $err_code the error code
 object the gift card object

Return
 string

---

Filter the gift card total balance saved

Params
 float the total balance rounded
 float the total balance
 object the gift card post object

Return
 float

---

Filter the gift card total amount saved

Params
 float the total amount rounded
 float the total amount
 object the gift card post object

Return
 float

---

includes/emails/class-yith-ywgc-email-send-gift-card.php

Filter the condition to set the gift card as sent

Params
 bool true to set it as sent, false to not. Default: true

Return
 bool

---

templates/checkout/form-gift-cards.php

Filter the condition display the gift card form in the gift card product page

Params
 bool true to display it, false to not. Default: true

Return
 bool

---

Filter the gift card field placeholder in the cart & checkout

Params
 string the placeholder

Return
 string

---

templates/myaccount/my-giftcards.php

Filter the columns to display in the gift card table in "My account"

Params
 array the columns

Return
 array

---

Filter the query to display in the gift cards table in "My account"

Params
 array the gift cards query

Return
 array

---

Filter the title to display in the gift card table in "My account"

Params
 string the table title

Return
 string

---

Filter the text to add a new gift card in the gift card table in "My account"

Params
 string the text

Return
 string

---

Filter the expiration message in the gift card table in "My account"

Params
 string the expiration message

Return
 string

---

Filter the default column in the gift card table in "My account"

Params
 string the column data
 int $column_id the column ID
 object $gift_card the gift card object

Return
 string

---

templates/single-product/add-to-cart/gift-card-add-to-cart.php

Filter the "Add to cart" button text for the gift card products

Params
 string the button text

Return
 string

---

templates/single-product/form-preview.php

Filter the "From" text in the gift card preview on the product page

Params
 string the text

Return
 string

---

Filter the "To" text in the gift card preview on the product page

Params
 string the text

Return
 string

---

templates/yith-gift-cards/ywgc-gift-card-template.php

Filter the company logo URL in the gift card template

Params
 string $company_logo_url the company logo URL
 string $context the context. Allowed values: "email" or "pdf"

Return
 string

---

Filter the custom gift card image URL in the gift card template

Params
 string $company_logo_url the custom gift card imag URL
 string $context the context. Allowed values: "email" or "pdf"

Return
 string

---