View Product Page

Filters

includes/admin-tables/class-yith-auction-product-table-list.php

Copied!
Copy

Filter the columns of the auctions table

Params
 array $columns Columns

Return array

Copied!
Copy

Filter the content of the default column in the auctions table

Params
 string     $output      Column output
 string     $column_name Column name
 WC_Product $product     Product object

Copied!
Copy

Filter the amount of items per page in the auctions table

Params
 int $per_page Number of items per page

Return int

Copied!
Copy

Filter the array with the arguments to get the auction products

Params
 array $args Array of arguments

Return array

Copied!
Copy

Filter the array with the filter statuses for the auction products

Params
 array $statuses Filter statuses

Return array

includes/class-yith-wcact-fee-product.php

Copied!
Copy

Filter the start label for the fee product in the cart

Params
 string $start_message Start message

Copied!
Copy

Filter the title for the fee product in the cart

Params
 string $product_title Product title
 array  $cart_item     Cart item
 string $cart_item_key Cart item key

Copied!
Copy

Filter whether to hide the fee product from the products list in the backend

Params
 bool     $hide_fee_product Whether to hide the fee product or not
 WP_Query $query            Query

Return bool

includes/class-yith-wcact-popup.php

Copied!
Copy

Filter the arguments sent to the popup template

Params
 array $args Array of the arguments.

Return array

Copied!
Copy

Filter the data sent to the popup script

Params
 array $data Data

Return array

Copied!
Copy

Filter whether to show the fee message

Params
 bool       $show_fee_message Whether to show the fee message or not
 WC_Product $product          Product object

Return bool

includes/class.yith-wcact-auction-admin-premium.php

Copied!
Copy

Filter the capability for the plugin panel

Params
 string $capability Capability

Return string

Copied!
Copy

Filter the auction product type options

Params
 array $product_type_options Product type options

Return array

Copied!
Copy

Filter the number of items that will be exported per page in the CSV

Params
 int $per_page Number of items per page

Return int

Copied!
Copy

Filter the columns of the auctions table

Params
 array $columns Columns

Return array

Copied!
Copy

Filter the content of the default column in the auctions table

Params
 string     $output      Column output
 string     $column_name Column name
 WC_Product $product     Product object

includes/class.yith-wcact-auction-admin.php

Copied!
Copy

Filter the available tabs in the plugin panel

Params
 array $tabs Admin tabs

Return array

Copied!
Copy

Filter the product types after adding the Auction type

Params
 array $types Product types

Return array

Copied!
Copy

Filter whether to show the auction price

Params
 bool $show_auction_price Whether to show the auction price or not.

Return bool

Copied!
Copy

Filter the price HTML for the auction product

Params
 string     $price_html Price HTML
 WC_Product $product    Product object
 string     $price      Current bid price

Return string

includes/class.yith-wcact-auction-ajax-premium.php

Copied!
Copy

Filter the URL to redirect to pay the won auction

Params
 string $url        URL
 int    $product_id Product ID

Return string

Copied!
Copy

Filter the URL to redirect when a guest user tries to place a bid

Params
 string $redirect_url Redirect URL

Return string

Copied!
Copy

Filter the product URL to redirect when a guest user tries to place a bid

Params
 string $redirect_url Redirect URL
 int    $product_id   Product ID

Return string

includes/class.yith-wcact-auction-ajax.php

Copied!
Copy

Filter the URL to redirect when a guest user tries to place a bid

Params
 string $redirect_url Redirect URL

Return string

Copied!
Copy

Filter the product URL to redirect when a guest user tries to place a bid

Params
 string $redirect_url Redirect URL
 int    $product_id   Product ID

Return string

includes/class.yith-wcact-auction-bids.php

Copied!
Copy

Filter the query results for the products where the user placed a bid

Params
 array  $results Query results
 int    $user_id User ID
 string $limit   Query limit

Return array

Copied!
Copy

Filter whether to delete the bids when the auction is rescheduled

Params
 bool $delete_bids Whether to delete the bids or not

Return bool

Copied!
Copy

Filter the query results for the products in the watchlist for a specific user

Params
 array  $results Query results
 int    $user_id User ID
 string $limit   Query limit

Return array

includes/class.yith-wcact-auction-cron.php

Copied!
Copy

Filter whether to create the cron event to reschedule non-paid auctions

Params
 bool       $create_event Whether to create cron event or not
 WC_Product $product      Product object

Return bool

includes/class.yith-wcact-auction-finish-auction.php

Copied!
Copy

Filter the URL to redirect guest users after login when trying to pay the auction

Params
 string $redirect_url Redirect URL
 int    $product_id   Product ID

Return string

Copied!
Copy

Filter the order URL when paying for the auction

Params
 string   $redirect_url Redirect URL
 int      $product_id   Product ID
 WC_Order $order        Order object

Return string

Copied!
Copy

Filter the URL to redirect to pay the won auction

Params
 string $url        URL
 int    $product_id Product ID

Return string

Copied!
Copy

Filter whether to automatically create the order for the auction winner

Params
 bool       $create_order Whether to automatically create order or not
 WC_Product $product      Product object

Return bool

includes/class.yith-wcact-auction-frontend-premium.php

Copied!
Copy

Filter whether to show time in customer time

Params
 bool $show_time_in_customer_time Whether to show time in customer time or not

Return bool

Copied!
Copy

Filter the increment value when adding a new bid

Params
 int $bid_value Bid value

Return int

Copied!
Copy

Filter whether the AJAX is activated

Params
 bool $ajax_activated Whether the AJAX is activated or not

Return bool

Copied!
Copy

Filter whether to load the script everywhere

Params
 bool $load_script Whether to load the script everywhere

Return bool

Copied!
Copy

Filter whether to load the widget script everywhere

Params
 bool $load_script Whether to load the widget script everywhere

Return bool

Copied!
Copy

Filter the array with the arguments to sort auctions

Params
 array  $args          Ordering args
 string $orderby_value Order by value

Return array

Copied!
Copy

Filter the auction product

Params
 WC_Product_Auction_Premium $product Auction product

Return WC_Product_Auction_Premium

Copied!
Copy

Filter the text for the label in the shop page for auction ended products

Params
 string     $text    Label text
 WC_Product_Auction_Premium $product Product

Return string

Copied!
Copy

Filter the text for the add to cart button in the shop page for auction products

Params
 string     $text    Button text
 WC_Product $product Product
 string     $text    Original text

Return string

Copied!
Copy

Filter the auction product ID

Params
 int $product_id Auction product ID

Return int

Copied!
Copy

Filter the array with the cart item data for the auction product

Params
 array $cart_item_data Cart item data

Return array

Copied!
Copy

Filter the array with the session data for the auction product

Params
 array $session_data Session data

Return array

Copied!
Copy

Filter the array with the arguments for the auction timeleft

Params
 array      $args    Array of arguments
 WC_Product $product Product

Return array

Copied!
Copy

Filter the text that will state the time left to start the auction

Params
 string $text Text

Return string

Copied!
Copy

Filter whether to show the 'Buy now' button

Params
 bool       $show_buy_now_button Whether to show the 'Buy now' button or not
 WC_Product $product             Product object
 string     $buy_now             Buy now price

Return bool

Copied!
Copy

Filter whether to show always the 'Buy now' button

Params
 bool       $show_buy_now_button Whether to show always the 'Buy now' button or not
 WC_Product $product             Product object
 string     $buy_now             Buy now price

Return bool

Copied!
Copy

Filter the 'Buy now' text in the auction product

Params
 string     Buy now text
 string     $buy_now Buy now price
 WC_Product $product Product object

Return string

Copied!
Copy

Filter the price to 'Buy now' the auction product

Params
 string     $buy_now Buy now price
 WC_Product $product Product object

Return string

Copied!
Copy

Filter whether to display the form to follow the auction

Params
 bool $display_followers_form Whether to show the form to follow the auction or not

Return bool

Copied!
Copy

Filter the message shown in the form to follow the auction

Params
 string $message Message

Return string

Copied!
Copy

Filter the privacy label

Params
 string $privacy_label Privacy label

Return string

Copied!
Copy

Filter whether the privacy checkbox is required in the form to follow the auction

Params
 bool $privacy_required Whether the privacy checkbox is required or not

Return bool

Copied!
Copy

Filter whether to show the auction countdown in the loop

Params
 bool       $show_auction_on_loop Whether to show the auction countdown in the loop or not
 WC_Product $product              Product object

Return bool

Copied!
Copy

Filter the array with the arguments for the auction timeleft in the loop

Params
 array $args Array of arguments

Return array

Copied!
Copy

Filter whether to apply the custom CSS rules in the loop

Params
 bool $apply_loop Whether to apply the custom CSS rules in the loop or not

Return bool

Copied!
Copy

Filter the custom CSS rules generated

Params
 string $generated_style_code Generated CSS rules
 array  $countdown_color      Countdown color options

Return string

Copied!
Copy

Filter whether to show the button to add to watchlist in the auction product page

Params
 bool       $show_watchlist_button Whether to show the button to add to watchlist in the auction product page
 WC_Product $product               Product object

Return bool

Copied!
Copy

Filter the message of the notice when an unlogged user tries to use the watchlist

Params
 string $message Message

Return string

includes/class.yith-wcact-auction-frontend.php

Copied!
Copy

Filter the title of the Bids tab

Params
 string $tab_title Tab title

Return string

Copied!
Copy

Filter the priority of the Bids tab

Params
 int $tab_priority Tab priority

Return int

Copied!
Copy

Filter the array with the product tabs after the Bids tab has been added

Params
 array $tabs Tabs

Return array

Copied!
Copy

Filter whether to show the auction price

Params
 bool $show_auction_price Whether to show the auction price or not.

Return bool

Copied!
Copy

Filter the current bid label

Params
 string     $current_bid_label Current bid label
 string     $price             Current bid price
 WC_Product $product           Product object

Return string

Copied!
Copy

Filter whether to display the commission fee for the auction

Params
 bool       $show_commission_fee Whether to display the commission fee or not
 WC_Product $product             Product object
 string     $price               Current bid price

Return bool

Copied!
Copy

Filter whether to show the auction type in the product page

Params
 bool $show_auction_type Whether to show the auction type or not

Return bool

Copied!
Copy

Filter the price HTML for the auction product

Params
 string     $price_html Price HTML
 WC_Product $product    Product object
 string     $price      Current bid price

Return string

Copied!
Copy

Filter whether to show the auction winner badge

Params
 bool $show_auction_winner_badge Whether to show the auction winner badge or not

Return bool

Copied!
Copy

Filter the label for the commission fee

Params
 bool    $label                        Label
 array   $auction_commission_fee_array Commission fee data
 WC_Cart $cart                         Cart object

Return string

includes/class.yith-wcact-auction-my-auctions.php

Copied!
Copy

Filter the number to limit how many actuions will be displayed in the My Account page

Params
 int $limit Limit

Return int

Copied!
Copy

Filter the URL to redirect to pay the won auction

Params
 string $url        URL
 int    $product_id Product ID

Return string

Copied!
Copy

Filter the message shown in the My Account page when the user has won the auction

Params
 string $message Message

Return string

Copied!
Copy

Filter the array with the data to be used in the My Account page

Params
 array $auctions Auctions data
 int   $user_id  User ID

Return array

includes/class.yith-wcact-auction-notify.php

Copied!
Copy

Filter whether to prevent the delivery of the email to notify that the auction has been closed by using the "Buy now" option

Params
 bool       $prevent_delivery Whether to prevent the delivery of the email or not
 int        $user_id          User ID
 WC_Product $product          Product object
 WC_Order   $order            Order object

Return bool

Copied!
Copy

Filter whether to show the link to unsubscribe in the emails

Params
 bool     $show_link Whether to show the unsubscribe link in the emails or not
 WC_Email $email     Email object

Return bool

Copied!
Copy

Filter the array with the arguments to build the unsubscribe URL

Params
 array  $args Array of arguments
 string $page Unsubscribe page URL

Return array

Copied!
Copy

Filter the URL to redirect after unsubscribing from the auction if not found the user

Params
 string $url URL

Return string

Copied!
Copy

Filter the array with the arguments for the unsubscribe logo

Params
 array $args Array of arguments

Return array

Copied!
Copy

Filter the array with the arguments for the unsubscribe content

Params
 array $args Array of arguments

Return array

includes/class.yith-wcact-auction-product-premium.php

Copied!
Copy

Filter the current bid for the auction

Params
 string                     $current_bid Current bid
 WC_Product_Auction_Premium $product     Auction product

Return string

Copied!
Copy

Filter the bid value for the current automatic bid

Params
 string                     $current_bid   Current bid
 WC_Product_Auction_Premium $product       Auction product
 string                     $first_bid     First bid
 string                     $second_bid    Second bid
 string                     $reserve_price Reserve price

Return string

Copied!
Copy

Filter the start price for the auction

Params
 string                     $start_price   Start price
 WC_Product_Auction_Premium $product       Auction product
 object                     $the_bid       Bid object
 string                     $bid_increment Bid increment
 string                     $reserve_price Reserve price

Return string

Copied!
Copy

Filter whether the auction product is visible

Params
 bool                       $is_visible Whether the auction product is visible or not
 WC_Product_Auction_Premium $product    Auction product

Return bool

Copied!
Copy

Filter whether to hide the closed auction

Params
 bool $hide_closed_auction Whether to hide closed auction or not
 bool $is_closed           Whether the auction is closed or not

Return bool

Copied!
Copy

Filter the bid increment for the current bid

Params
 string                     $bid_increment Bid increment
 WC_Product_Auction_Premium $product       Auction product

Return string

Copied!
Copy

Filter the bid increment

Params
 string                     $bid_increment Bid increment
 WC_Product_Auction_Premium $product       Auction product

Return string

Copied!
Copy

Filter the term for the auction status

Params
 string                     $auction_status_term Auction status
 WC_Product_Auction_Premium $product             Auction product

Return string

includes/class.yith-wcact-auction-product.php

Copied!
Copy

Filter the current product price

Params
 string     $price Price
 WC_Product $product Product object

Return $price

includes/class.yith-wcact-auction-shortcodes.php

Copied!
Copy

Filter the "Order by" options for the shortcodes

Params
 array  $order_by_options Order by options
 array  $query_args       Query args
 array  $atts             Shortcode attributes
 string $loop_name        Loop name

Return array

Copied!
Copy

Filter whether to show the auctions count in the shortcode

Params
 bool $show_count Whether to show auction count or not

Return bool

Copied!
Copy

Filter the default "Order by" option in the shortcodes

Params
 string $default_option Default order by option

Return string

Copied!
Copy

Filter the array with the arguments to order products in the shortcode

Params
 array  $args    Array of arguments
 string $orderby Order by option

Return array

Copied!
Copy

Filter whether the AJAX is activated

Params
 bool $ajax_activated Whether the AJAX is activated or not

Return bool

Copied!
Copy

Filter the watchlist icon

Params
 string $watchlist_icon Watchlist icon

Return string

Copied!
Copy

Filter the text to add the auction to the watchlist

Params
 string $add_watchlist_text 'Add to watchlist' text

Return string

Copied!
Copy

Filter the text to browse your watchlist

Params
 string $browse_watchlist_text 'Browse your watchlist' text

Return string

Copied!
Copy

Filter the text when the product is already in the watchlist

Params
 string $already_in_watchlist 'Already in watchlist' text

Return string

Copied!
Copy

Filter the text when the product has been added to the watchlist

Params
 string $product_added 'Product added to watchlist' text

Return string

Copied!
Copy

Filter whether to show the count of the products in the watchlist

Params
 bool $show_watchlist_count Whether to show the watchlist count or not

Return bool

Copied!
Copy

Filter the array with the parameters needed to add the product to the watchlist

Params
 array $additional_params Parameters
 array $atts              Array of attributes

Return array

Copied!
Copy

Filter the array with the attributes used for the 'Other auctions' shortcode

Params
 array $atts Array of attributes

Return array

Copied!
Copy

Filter the array with the arguments sent to the template

Params
 array $args Array of arguments

Return array

Copied!
Copy

Filter the query arguments when setting categories in the shortcode loops

Params
 array $query_args Query args

Return array

includes/class.yith-wcact-auction-widget.php

Copied!
Copy

Filter the array with the query args for the query in the widget

Params
 array $query_args Query args

Return array

Copied!
Copy

Filter the HTML displayed before the products list in the widget

Params
 string $html_content HTML content

Return string

Copied!
Copy

Filter the HTML displayed after the products list in the widget

Params
 string $html_content HTML content

Return string

includes/class.yith-wcact-auction.php

Copied!
Copy

Filter the required files to be loaded in the plugin

Params
 array $files Required files

Return array

Copied!
Copy

Filter the privacy label

Params
 string $privacy_label Privacy label

Return string

Copied!
Copy

Filter the object type with witch the taxonomy will be associated

Params
 array $object_type Object type

Return array

Copied!
Copy

Filter the array with the parameters used in the taxonomy creation

Params
 array $taxonomy_args Taxonomy args

Return array

Copied!
Copy

Filter the array with the taxonomy terms

Params
 array $taxonomy_terms Taxonomy terms

Return array

Copied!
Copy

Filter whether to show time in customer time

Params
 bool $show_time_in_customer_time Whether to show time in customer time or not

Return bool

Copied!
Copy

Filter the increment value when adding a new bid

Params
 int $bid_value Bid value

Return int

includes/compatibility/class.yith-wcact-compatibility-premium.php

Copied!
Copy

Filter the minimum version of YITH WooCommerce Multi Vendor to use for the integration

Params
 string $min_version Minimum version

Return string

includes/compatibility/class.yith-wcact-stripe-compatibility.php

Copied!
Copy

Filter the number of maximum payments attempts to charge the auction automatically

Params
 int $max_payment_attempts Max payment attempts

Return int

Copied!
Copy

Filter the description sent to Stripe for the automatic charge

Params
 string $charge_description Charge description
 string $blog_name          Blog name
 int    $order_number       Order number

Return string

Copied!
Copy

Filter the array with the metadata sent to Stripe for the automatic charge

Params
 array  $metadata    Meta data
 string $charge_type Charge type

Return array

Copied!
Copy

Filter whether to schedule a new payment attempt

Params
 bool $schedule_new_attempt Whether to schedule a new payment attempt or not

Return bool

Copied!
Copy

Filter the interval to schedule new payment attempts

Params
 int        $interval Time interval
 WC_Order   $order    Order object
 WC_Product $product  Product object

Return int

includes/compatibility/wpml/class.yith-wcact-wpml-auction-product.php

Copied!
Copy

Filter the current product price

Params
 string     $price Price
 WC_Product $product Product object

Return $price

includes/emails/class.yith-wcact-auction-email-auction-winner.php

Copied!
Copy

Filter the URL of the button to pay the auction in the winner email

Params
 string $url URL

Return string

Copied!
Copy

Filter whether to show the section to pay the auction in the winner email

Params
 bool     $show_pay_now_button Whether to show the button to pay or not
 WC_Email $email               Email object

Return bool

Copied!
Copy

Filter the label to pay the auction in the winner email

Params
 string $label Label

Return string

Copied!
Copy

Filter whether to show the button to pay the auction in the winner email

Params
 bool $show_pay_now_button Whether to show the button to pay or not

Return bool

Copied!
Copy

Filter the URL of the button to pay the auction in the winner email

Params
 string   $url   URL
 WC_Email $email Email object

Return string

includes/functions-ywcact-product.php

Copied!
Copy

Filter the fee amount for the auction

Params
 string     $fee_amount Fee amount
 WC_Product $product    Product object

Return string

Copied!
Copy

Filter the message displayed to the auction winner

Params
 string     $fee_amount                       Fee amount
 array      $search                           Array with placeholders to replace
 array      $replace                          Array with data to replace placeholders
 string     $congratulations_message_settings Congratulations message
 WC_Product $product                          Product object
 WP_User    $user                             User object

Return string

Copied!
Copy

Filter the message shown to notify that a commissions will be charged for the auction

Params
 string     $fee_amount Fee amount
 WC_Product $product    Product object

Return string

Copied!
Copy

Filter the array with the data for the commission fee

Params
 array      $commision_fee Commission fee data
 WC_Product $product       Product object
 double     $price         Price

Return array

includes/functions-ywcact.php

Copied!
Copy

Filter the array of the arguments for the fields in the product metabox

Params
 array $args  Array of arguments
 array $field Field

Return array

Copied!
Copy

Filter the HTML for the fields in the product metabox

Params
 string $html  Field HTML
 array  $field Field

Return string

Copied!
Copy

Filter the value of the onoff fields in the product metabox

Params
 string     $position   Position
 string     $field      Field
 string     $dependency Dependency
 WC_Product $product    Product object
 string     $value      Field value

Return string

Copied!
Copy

Filter the message used in the AJAX call

Params
 string     $message Message
 int        $type    Message type
 WC_Product $product Product object

Return string

Copied!
Copy

Filter the array with the icons for the different auction statuses

Params
 array $icons Icons

Return array

Copied!
Copy

Filter the array with classes for the unsubscribe body

Params
 array $classes CSS Classes

Return array

Copied!
Copy

Filter the default label

Params
 string $label  Label
 string $key    Label key
 array  $labels Array of labels

Return string

Copied!
Copy

Filter the default status for the order created automatically for the auction

Params
 string $default_order_status Default order status

Return string

Copied!
Copy

Filter whether to show the logs created by the plugin

Params
 bool $show_logs Whether to show logs or not

Return bool

includes/widget/class.yith-wcact-auction-widget-ended.php

Copied!
Copy

Filter the array with the query args for the query in the widget

Params
 array $query_args Query args

Return array

Copied!
Copy

Filter the HTML displayed before the products list in the widget

Params
 string $html_content HTML content

Return string

Copied!
Copy

Filter the HTML displayed after the products list in the widget

Params
 string $html_content HTML content

Return string

includes/widget/class.yith-wcact-auction-widget-ending-soon.php

Copied!
Copy

Filter the array with the query args for the query in the widget

Params
 array $query_args Query args

Return array

Copied!
Copy

Filter the HTML displayed before the products list in the widget

Params
 string $html_content HTML content

Return string

Copied!
Copy

Filter the HTML displayed after the products list in the widget

Params
 string $html_content HTML content

Return string

includes/widget/class.yith-wcact-auction-widget-future.php

Copied!
Copy

Filter the array with the query args for the query in the widget

Params
 array $query_args Query args

Return array

Copied!
Copy

Filter the HTML displayed before the products list in the widget

Params
 string $html_content HTML content

Return string

Copied!
Copy

Filter the HTML displayed after the products list in the widget

Params
 string $html_content HTML content

Return string

includes/widget/class.yith-wcact-auction-widget-watchlist.php

Copied!
Copy

Filter the array with the arguments sent to the template for the watchlist widget

Params
 array $args Array of arguments

Return array

Copied!
Copy

Filter the watchlist icon

Params
 string $watchlist_icon Watchlist icon

Return string

plugin-options/customization-options.php

Copied!
Copy

Filter the options available in the Customization tab

Params
 array $customization_options Customization options

Return array

plugin-options/general-options.php

Copied!
Copy

Filter the options available in the General settings tab

Params
 array $general_settings General settings options

Return array

plugin-options/general/auctions-options.php

Copied!
Copy

Filter the options available in the General Auction Options tab

Params
 array $general_auction_options General auction options

Return array

plugin-options/general/auctions-rescheduling-options.php

Copied!
Copy

Filter the options available in the General Auctions Rescheduling tab

Params
 array $general_auction_rescheduling General auctions rescheduling options

Return array

plugin-options/general/auctions-winner-options.php

Copied!
Copy

Filter the options available in the General Auctions Payments tab

Params
 array $general_auction_payments General auctions payments options

Return array

templates/admin/admin-auction-status.php

Copied!
Copy

Filter whether to show if the winner email has been sent

Params
 bool       $check_email_is_send Whether to show if the winner email has been sent or not
 WC_Product $product             Product object

Return bool

templates/admin/admin-list-bids.php

Copied!
Copy

Filter whether to show the start price in the bids table in the backend

Params
 bool $show_start_price Whether to show the start price or not

Return bool

templates/emails/auction-winner-reminder.php

Copied!
Copy

Filter the URL of the button to pay for the auction

Params
 string  $url Button URL
 WC_Email $email Email object

Return string

templates/emails/better-bid.php

Copied!
Copy

Filter the URL of the button to pay the auction in the winner email

Params
 string   $url   URL
 WC_Email $email Email object

Return string

templates/emails/end-auction.php

Copied!
Copy

Filter the URL of the button to pay the auction in the winner email

Params
 string   $url   URL
 WC_Email $email Email object

Return string

templates/emails/product-emails/product-email.php

Copied!
Copy

Filter the auction product image in the emails

Params
 string $auction_thumbnail Auction thumbnail

Return string

templates/emails/stripe/couldnt-process-payment.php

Copied!
Copy

Filter the checkout URL to pay the auction

Params
 string   $url   Checkout URL
 WC_Email $email Email object

Return string

templates/emails/stripe/payment-failed.php

Copied!
Copy

Filter the checkout URL to pay the auction

Params
 string   $url   Checkout URL
 WC_Email $email Email object

Return string

templates/frontend/add-to-watchlist.php

Copied!
Copy

Filter the "Add to watchlist" title

Params
 string $title Title

Return string

templates/frontend/bid-confirmation-popup.php

Copied!
Copy

Filter the title shown in the popup when bidding

Params
 string $message Message
 string $price_format The price

Return string

Copied!
Copy

Filter the message shown in the popup when bidding

Params
 string $message Message

Return string

Copied!
Copy

Filter the message shown in the popup when bidding

Params
 string $message Message

Return string

templates/frontend/fee-amount-message.php

Copied!
Copy

Filter the message shown in the product page to notify that the payment of a fee is mandatory in order to be able to bid

Params
 string $message Message

Return string

Copied!
Copy

Filter the message shown in the popup to notify that the payment of a fee is mandatory in order to be able to bid

Params
 string $message Message

Return string

templates/frontend/list-bids.php

Copied!
Copy

Filter whether to show the bids list in the product page

Params
 bool $show_bids_list Whether to show bids list or not

Return bool

Copied!
Copy

Filter the status of the auction, to check if it is sealed or not

Params
 string                     $product_sealed Is the auction sealed or not
 WC_Product_Auction_Premium $product        Auction product

Return string

Copied!
Copy

Filter the bid amount

Params
 string $bid      Bid amount
 string $currency Currency

Return string

Copied!
Copy

Filter the auction product ID

Params
 int $product_id Auction product ID

Return int

Copied!
Copy

Filter the message shown in the bids list when the auction is sealed

Params
 string $message Message

Return string

Copied!
Copy

Filter the column heading to show the bid time

Params
 string $heading Heading

Return string

Copied!
Copy

Filter the text shown for the bidder when it's not possible to retrieve the username

Params
 string  $text Text
 WP_User $user User object

Return string

Copied!
Copy

Filter the bidder username

Params
 string  $username Bidder username
 WP_User $user     User object

Return string

Copied!
Copy

Filter whether to show the bidder username

Params
 bool $show_bidder_name Whether to show the bidder username or not
 int  $user_id          User ID

Return bool

Copied!
Copy

Filter the auction product price

Params
 string $bid_price Bid price
 string $bid       Bid
 string $currency  Currency

Return string

templates/frontend/max-bidder.php

Copied!
Copy

Filter the "Bid up" text in the product page


Return string

Copied!
Copy

Filter the auction product price

Params
 string $bid_price Bid price
 string $bid       Bid
 string $currency  Currency

Return string

Copied!
Copy

Filter the message displayed to notify the user that is the highest bidder

Params
 string $message Message

Return string

Copied!
Copy

Filter the message displayed to show the maximum bid from the user

Params
 string $message Message

Return string

templates/frontend/my-account/my-account-my-auction.php

Copied!
Copy

Filter the auction product price

Params
 string $bid_price Bid price
 string $bid       Bid
 string $currency  Currency

Return string

templates/frontend/my-account/my-auctions-index.php

Copied!
Copy

Filter the title of the My Auctions section in the endpoint in My Account page

Params
 string $text Text

Return string

Copied!
Copy

Filter the auction product price

Params
 string $bid_price Bid price
 string $bid       Bid
 string $currency  Currency

Return string

Copied!
Copy

Filter whether to show the "Pay now" button

Params
 bool $show_button Whether to show the "Pay now" button

Return bool

Copied!
Copy

Filter the title of the icon to remove the product from the watchlist

Params
 string $title Title

Return string

templates/frontend/my-account/my-auctions-my-watchlist.php

Copied!
Copy

Params
 string $title Title

Return string

Copied!
Copy

Filter the auction product price

Params
 string $bid_price Bid price
 string $bid       Bid
 string $currency  Currency

Return string

templates/frontend/reserve_price_and_overtime.php

Copied!
Copy

Filter the minimum bid amount

Params
 int                        $manual_min_bid Manual min bid
 WC_Product_Auction_Premium $product        Auction product

Return int

Copied!
Copy

Filter the maximum bid amount

Params
 int                        $manual_max_bid Manual max bid
 WC_Product_Auction_Premium $product        Auction product

Return int

Copied!
Copy

Filter the text for the manual bid increment

Params
 string                     $text    Text
 WC_Product_Auction_Premium $product Auction product

Return string

Copied!
Copy

Filter the message shown when the product has exceeded the reserve price

Params
 string $message Message

Return string

Copied!
Copy

Filter the message shown when the product has a reserve price

Params
 string                     $message Message
 WC_Product_Auction_Premium $product Auction product
 int                        $userid  User ID

Return string

Copied!
Copy

Filter the message shown when the product doesn't have a reserve price

Params
 string $message Message

Return string

templates/frontend/shortcodes/follower-list.php

Copied!
Copy

Filter the title to unsubscribe from the auction

Params
 string $title Auction title
 WC_Product_Auction_Premium $auction Auction product

templates/woocommerce/single-product/add-to-cart/auction-ended.php

Copied!
Copy

Filter the message title shown the auction winner

Params
 string $title Title

Return string

Copied!
Copy

Filter whether to show the buttons to pay the auction when it is ended

Params
 bool $show_buttons Whether to show buttons or not

Return bool

Copied!
Copy

Filter the message shown when the auction is closed by 'Buy now'

Params
 string $message Message

Return string

Copied!
Copy

Filter the label displayed in the product page when the auction has ended

Params
 string $label Label

Return string

Copied!
Copy

Filter whether to show other auctions when the auction is closed

Params
 bool $show_other_auctions Message
 WC_Product_Auction_Premium $product Auction product

Return bool

templates/woocommerce/single-product/add-to-cart/auction.php

Copied!
Copy

Filter the auction product

Params
 WC_Product_Auction_Premium $product Auction product

Return WC_Product_Auction_Premium

Copied!
Copy

Filter whether to render the auction product content before the add to cart

Params
 bool                       $render_content Whether to render content or not
 WC_Product_Auction_Premium $product        Auction product

Return bool

Copied!
Copy

Filter whether to render the form to bid in the auction product page

Params
 bool                       $show_bid_form Whether to show the form to bid or not
 WC_Product_Auction_Premium $product       Auction product

Return bool

Copied!
Copy

Filter the array with the CSS clases for the quantity input in auction products

Params
 array                      $input_class_quantity CSS classes
 WC_Product_Auction_Premium $product              Auction product

Return array

Copied!
Copy

Filter the step in the quantity field in the auction products

Params
 int                        $min_incr_amount CSS classes
 WC_Product_Auction_Premium $product         Auction product

Return int

Copied!
Copy

Filter the actual bid value

Params
 int                        $actual_amount Actual bid value
 WC_Product_Auction_Premium $product       Auction product

Return int

Copied!
Copy

Filter the classes of the button to place a bid

Params
 string                     $classes Button classes
 WC_Product_Auction_Premium $product Auction product
 WP_User                    $user    User object

Return string

Copied!
Copy

Filter the label of the button to place a bid

Params
 string $label Button label

Return string

Copied!
Copy

Filter the message shown when the auction has not started yet

Params
 string                     $label   Button label
 WC_Product_Auction_Premium $product Auction product

Return string

templates/woocommerce/widgets/ywcact-watchlist-products.php

Copied!
Copy

Filter the message shown when there are not any items in the watchlist

Params
 string $message Message

Return string

templates/woocommerce/widgets/ywcact-watchlist.php

Copied!
Copy

Filter the content to show before the widget

Params
 string $before_widget Content before the widget

Return string

Copied!
Copy

Filter the title of the watchlist widget when using the extended style

Params
 string $widget_title Content before the widget

Return string

Copied!
Copy

Filter the content to show after the widget

Params
 string $after_widget Content after the widget

Return string

views/auction-tab/extras.php

Copied!
Copy

Filter the default value of the field to set whether reschedule ended auctions when the reserve price has not been reached

Params
 string $default_value Default value

Return string

views/auction-tab/general.php

Copied!
Copy

Filter the default auction type value

Params
 string $default_value Default value

Return string

Copied!
Copy

Filter the array with the auction type options

Params
 array $auction_type_options Auction type options

Return array

Copied!
Copy

Filter the default field value in the metabox

Params
 string $value Value
 string $field Field

Return string

Copied!
Copy

Filter whether to show the auction date fields in the product in the backend

Params
 bool       $show_auction_dates Whether to show if the winner email has been sent or not
 WC_Product $auction_product    Product object

Return bool