Filters

includes/admin/class-yith-wcbk-booking-calendar.php

Filters the time-steps in Booking admin calendar

Params
 array $time_steps  The time steps.

Return
 array

---

includes/admin/post-types/class-yith-wcbk-booking-create.php

Filters the product id to be translated (if you need to translate it)

Params
 int $product_id The args.

Return
 int

---

includes/class-yith-wcbk-admin.php

Filters the admin settings tab

Params
 array $tabs The tabs.

Return
 array

---

Filters the plugin panel arguments

Params
 array $args The arguments.

Return
 array

---

includes/class-yith-wcbk-ajax.php

Filters the booking note before being added

Params
 string $note The note.

Return
 string

---

Filters the search term when searching for orders in AJAX

Params
 string $term The term.

Return
 string

---

Filters the limit of orders searched when searching for orders in AJAX

Params
 int $limit The limit.

Return
 int

---

Filters the order number shown when searching for orders in AJAX

Params
 string $order_number The order number.
 int    $order_id     The order ID.

Return
 string

---

Filters the args passed to get_post when searching for bookable products in AJAX

Params
 array $args The arguments.

Return
 array

---

Filters the bookable products before returning them when searching for them in AJAX

Params
 array $found_products The products' key-value array (key is the product id, value is the formatted product name).

Return
 array The products' key-value array (key is the product id, value is the formatted product name).

---

Filters the request when retrieving booking data in AJAX

Params
 array $request The request.

Return
 array

---

Filters the args used to check for availability when retrieving booking data in AJAX

Params
 array              $is_available_args The arguments.
 WC_Product_Booking $product           The bookable product.
 array              $request           The request.

Return
 array

---

Filters the calculated price of the bookable product

Params
 float|int          $price   The price.
 array              $args    The arguments.
 WC_Product_Booking $product The bookable product.

Return
 float|int

---

Filters the totals to be shown in the booking form

Params
 string             $totals_html The totals HTML.
 array              $totals      The totals.
 string             $price_html  The price HTML.
 WC_Product_Booking $product     The bookable product.
 array              $request     The request.

Return
 string

---

Filters the price to be shown in the booking form when the product is non-bookable

Params
 string $price_html    The price HTML.
 array  $request       The request.
 array  $bookable_args The arguments.

Return
 string

---

Filters the booking data retrieved in AJAX

Params
 array              $booking_data  The data.
 WC_Product_Booking $product       The bookable product.
 array              $bookable_args The arguments.
 array              $request       The request.

Return
 array

---

Filters the request when retrieving the booking available times in AJAX

Params
 array $request The request.

Return
 array

---

Filters the availability args used when retrieving the booking available times in AJAX

Params
 array $args    The args.
 array $request The request.

Return
 array

---

Filters the formatted time when retrieving the booking available times in AJAX

Params
 string             $formatted_time The formatted time.
 string             $time           The time.
 WC_Product_Booking $product        The bookable product.

Return
 string

---

Filters the availability args when retrieving the non-available dates in AJAX

Params
 array             $availability_args The args.
 array             $request           The request.

Return
 array

---

includes/class-yith-wcbk-assets.php

Filters the params used by the JS script for the people selector

Params
 array $params The params.

Return
 array

---

Filters the 'clear' text used in date-pickers

Params
 string $text The text.

Return
 string

---

Filters the plugin scripts

Params
 array  $scripts The scripts.
 string $context The context.

Return
 array

---

Filters the plugin styles

Params
 array  $styles  The styles.
 string $context The context.

Return
 array

---

Filters if disabling the WooCommerce check for changes in settings panels

Params
 bool $disable True to disable the check; false otherwise.

Return
 bool

---

Filters params of the global 'bk' JS variable

Params
 array  $bk      The params.
 string $context The context.

Return
 array

---

includes/class-yith-wcbk-booking-helper.php

Filters the query args used when counting booked bookings in a specific period

Params
 array $query_args The query args.
 array $args       The args.

Return
 array

---

Filters the count retrieved when counting booked bookings in a specific period

Params
 int   $count The count.
 array $args  The args.

Return
 int

---

Filters the arguments when counting the maximum number of booked bookings in a large specific period

Params
 array $args The args.

Return
 array

---

Filters the arguments when retrieving future bookings for a specific product

Params
 array $args       The args.
 int   $product_id The product ID.

Return
 array

---

Filters the bookings retrieved for a specific order before being retrieved

Params
 YITH_WCBK_Booking[]|null $bookings      The bookings.
 int                      $order_id      The order ID.
 int                      $order_item_id The order item ID.

Return
 YITH_WCBK_Booking[]|null

---

Filters the arguments used when retrieving bookings for a specific order

Params
 array $args          The arguments.
 int   $order_id      The order ID.
 int   $order_item_id The order item ID.

Return
 array

---

Filters the arguments used when retrieving bookings in a specific time range

Params
 array $args The arguments.

Return
 array

---

Filters the bookings retrieved in a specific time range

Params
 YITH_WCBK_Booking[] $bookings The bookings.
 array               $params   The request params.
 array               $args     The arguments.

Return
 YITH_WCBK_Booking[]

---

includes/class-yith-wcbk-cache.php

Filters the object data ID in the internal cache

Params
 int          $id          The object ID.
 string       $object_type Object type.
 string|array $key_args    The key arguments.

Return
 int

---

Filters the object data ID in the internal cache

Params
 int          $id          The object ID.
 string       $object_type Object type.
 string|array $key_args    The key arguments.

Return
 int

---

includes/class-yith-wcbk-cart.php

Filters the request when retrieving booking data from request in cart

Params
 array $request The request.

Return
 array

---

Filters the booking data retrieved from a specific request in cart

Params
 array              $booking_data The booking data.
 array              $request      The request.
 WC_Product_Booking $product      The product.

Return
 array

---

Filters the booking props retrieved from booking data in cart

Params
 array $props        The props.
 array $booking_data The booking data.

Return
 array

---

Filters the booking data from a specific booking

Params
 array             $booking_data The booking data.
 YITH_WCBK_Booking $booking      The booking.

Return
 array

---

Filters the availability args retrieved from booking data in cart

Params
 array $args         The args.
 array $booking_data The booking data.

Return
 array

---

Filters the product id to be translated (if you need to translate it)

Params
 int $product_id The args.

Return
 int

---

Filters the message shown in cart when it's not possible adding to cart a bookable product (with the selected data: dates, persons, and so on...)

Params
 string $html_message  The HTML message.
 string $cart_url      Cart URL.
 string $product_title The product title.
 string $remained_text The text explaining how much "seats" are available.

Return
 string

---

Filters the validation when adding a bookable product to the cart

Params
 bool               $passed_validation True if passed validation; false otherwise.
 WC_Product_Booking $product           The bookable product.
 array              $booking_data      The booking data.

Return
 bool

---

Filters the item data related to a bookable product item in cart (before the totals item data)

Params
 array              $booking_item_data The  item data.
 array              $cart_item         The cart item.
 WC_Product_Booking $product           The bookable product.

Return
 array

---

includes/class-yith-wcbk-date-helper.php

Filters the difference of 2 dates

Params
 bool|DateInterval|int $value      The value.
 int                   $timestamp1 The first timestamp.
 int                   $timestamp2 The second timestamp.
 string                $return     The return type.

Return
 bool|DateInterval|int

---

includes/class-yith-wcbk-endpoints.php

Filters the booking plugin endpoints

Params
 array $endpoints The endpoints.

Return
 array

---

Filters the 'bookings' endpoint

Params
 string $endpoint The endpoint.

Return
 string

---

Filters if this is the current endpoint

Params
 bool $is_current_endpoint True if we're in the current endpoint; false otherwise.

Return
 bool

---

Filters the 'bookings' endpoint

Params
 string $endpoint The endpoint.

Return
 string

---

Filters the 'bookings' endpoint

Params
 string $endpoint The endpoint.

Return
 string

---

Filters the number of bookings to be shown per page in the "My Account > Bookings" page

Params
 int $per_page The number of bookings to be shown per page.

Return
 int

---

includes/class-yith-wcbk-frontend-action-handler.php

Filters the product ID when creating a booking for a confirmation request

Params
 int $product_id The product ID.

Return
 int

---

Filters if the user need to be logged-in to make a confirmation request

Params
 bool $login_required True if the login is required; false otherwise.

Return
 bool

---

Filters the notice message shown when trying to request confirmation if login is required and the user is not logged-in

Params
 string $notice_message The notice message.

Return
 string

---

Filters the button text shown when trying to request confirmation if login is required and the user is not logged-in

Params
 string $text The text.

Return
 string

---

Filters the notice shown when trying to request confirmation if login is required and the user is not logged-in

Params
 string             $notice  The notice.
 WC_Product_Booking $product The product.

Return
 string

---

Filters the success notice shown on request confirmation

Params
 string $notice The notice.

Return
 string

---

Filters the error notice shown on request confirmation

Params
 string $notice The notice.

Return
 string

---

Filters the redirect URL after requesting confirmation

Params
 bool|string        $redirect_url The redirect URL.
 bool               $success      True if the booking was correctly created; false otherwise.
 YITH_WCBK_Booking  $booking      The booking.
 WC_Product_Booking $product      The bookable product.
 array              $props        The booking props.
 array              $args         The request arguments.

Return
 bool|string specific redirect URL; False to set the default redirect.

---

includes/class-yith-wcbk-language.php

Filters a specific label

Params
 string $label The label.
 string $key   The key.

Return
 string

---

Filters the default labels label

Params
 array $labels The labels.

Return
 array

---

includes/class-yith-wcbk-logger.php

Filters if the logger is enabled

Params
 bool $enabled True if enabled; false otherwise.

Return
 bool

---

includes/class-yith-wcbk-orders.php

Params
 YITH_WCBK_Booking[] $bookings The bookings.
 WC_Order            $order    The order.

Return
 YITH_WCBK_Booking[]

---

Params
 YITH_WCBK_Booking[] $bookings The bookings.
 WC_Order            $order    The order.

Return
 YITH_WCBK_Booking[]

---

Filters the "Related Bookings" title

Params
 string $title The title.

Return
 string

---

Filters the booking order item detals

Params
 array $details      The details.
 array $booking_data Booking data array.
 int   $product_id   Product ID.

Return
 array

---

Filters if checking the order for bookings

Params
 bool  $check      True to check; false otherwise.
 int   $order_id   The order ID.
 array $deprecated Deprecated param.

Return
 bool

---

Filters if checking the order item for booking

Params
 bool          $check      True to check; false otherwise.
 WC_Order      $order      The order.
 WC_Order_Item $order_item The order item.

Return
 bool

---

Filters the product id to be translated (if you need to translate it)

Params
 int $product_id The args.

Return
 int

---

Filters if forcing private meta-data on booking creating in Orders

Params
 bool   $force True to force private meta-data; false otherwise.
 string $prop  The prop.

Return
 bool

---

Filters if associating order data to a newly created booking

Params
 bool              $associate  True to associate; false otherwise.
 YITH_WCBK_Booking $booking    The booking.
 WC_Order          $order      The order.
 WC_Order_Item     $order_item The order_item.

Return
 bool

---

Filters if setting booking as paid (when setting the order to 'processing' or 'completed')

Params
 bool     $set_as_paid True to set as paid; false otherwise.
 int      $order_id    Order ID.
 WC_Order $order       The Order.

Return
 bool

---

Filters if setting a specific booking as paid

Params
 bool              $set_as_paid True to set as paid; false otherwise.
 YITH_WCBK_Booking $booking     The booking.
 WC_Order          $order       The Order.

Return
 bool

---

includes/class-yith-wcbk-post-types.php

Filters the post-types handled by the plugin

Params
 string[] $post_types The post types.

Return
 string[]

---

includes/class-yith-wcbk-settings.php

Filters the enable status of the internal cache

Params
 boolean $enabled True if enabled; false otherwise.

Return
 boolean

---

includes/class-yith-wcbk.php

Filters if the specific user has permissions to view booking and its details

Params
 boolean           $can     True if the user has permissions to view; false otherwise.
 int               $user_id The user ID.
 YITH_WCBK_Booking $booking The booking.

Return
 boolean

---

Filters the check result on the current request

Params
 boolean $result True if this is a request for the specific "type"; false otherwise.
 string  $type   The type of the request (i.e.: admin, rest, ajax, cron, frontend).

Return
 boolean

---

includes/data/abstract-yith-wcbk-booking.php

Filters the product title shown in booking details

Params
 string            $title   The product title.
 YITH_WCBK_Booking $booking The booking.

Return
 string

---

includes/data/class-wc-product-booking.php

Filters the bookable product price

Params
 string             $price   The price.
 WC_Product_Booking $product The bookable product.

Return
 string

---

Filters the bookable product HTML price

Params
 string             $price_html The HTML price.
 WC_Product_Booking $product    The bookable product.

Return
 string

---

Filters the args used when checking a bookable product is available

Params
 array              $args    The arguments.
 WC_Product_Booking $product The bookable product.

Return
 array

---

Filters the available data when checking for the availability of a bookable product

Params
 array              $available_data The available data.
 array              $args           Arguments.
 WC_Product_Booking $product        The bookable product.

Return
 array

---

Filters the available status when checking for the availability of a bookable product

Params
 boolean            $available Available flag.
 array              $args      Arguments.
 WC_Product_Booking $product   The bookable product.

Return
 boolean

---

Filters the non-available reasons when checking for the availability of a bookable product

Params
 array              $non_available_reasons Non-available reasons.
 array              $args                  Arguments.
 WC_Product_Booking $product               The bookable product.
 int                $_remained             The number of seats remained.

Return
 array

---

Filters the available data when checking for the availability of a bookable product

Params
 array              $available_data The available data.
 array              $args           Arguments.
 WC_Product_Booking $product        The bookable product.

Return
 array

---

Filters if the bookable product is virtual

Params
 boolean            $is_virtual Is virtual flag.
 WC_Product_Booking $product    The bookable product.

Return
 boolean

---

Filters the calculated price of the bookable product

Params
 float|int          $price   The price.
 array              $args    The arguments.
 WC_Product_Booking $product The bookable product.

Return
 float|int

---

includes/data/class-yith-wcbk-product-availability-handler.php

Filters the product id to be translated (if you need to translate it)

Params
 int $product_id The args.

Return
 int

---

includes/functions.yith-wcbk-booking.php

Filters the booking available statuses

Params
 array $statuses The statuses.

Return
 array

---

Filters the booking object before returning it

Params
 YITH_WCBK_Booking $booking The booking.

Return
 YITH_WCBK_Booking

---

Filters the booking statuses considered to be booked (so, they'll block the related dates)

Params
 string[] $statuses The statuses.

Return
 string[]

---

Filters the booking statuses available in the bulk-actions on admin side

Params
 string[] $statuses The statuses.

Return
 string[]

---

Filters if using the lookup tables for bookings.
Be careful by using this filter, since setting it to false will negatively impact on performances

Params
 boolean $use True to use it; false otherwise.

Return
 boolean

---

includes/functions.yith-wcbk-core.php

Filters the duration units

Params
 array $duration_units The duration units.
 int   $plural_control The plural control (1 for singular; 2 for plural).

Return
 array

---

Filters the duration units for the "cancel" option

Params
 array $duration_units The duration units.

Return
 array

---

Filters the minimum minute increment

Params
 int $increment The increment.

Return
 int

---

Filters the maximum number of months to load for a specific duration unit

Params
 int    $months_to_load The number of months to load.
 string $unit           The duration unit.

Return
 int

---

Filters the HTML info for a specific user (to be shown on admin side)

Params
 string            $html    The HTML info.
 YITH_WCBK_Booking $booking The booking.
 WP_User           $user    The user.

Return
 string

---

Filters the HTML info for a non-defined or not found user (to be shown on admin side)

Params
 string            $html    The HTML info.
 YITH_WCBK_Booking $booking The booking.

Return
 string

---

Filters the default plugin colors

Params
 array $defaults The colors.

Return
 array

---

Filters the parameter retrieved from the query string

Params
 mixed $value The value.
 string $key The key.

Return
 mixed

---

includes/functions.yith-wcbk-labels.php

Filters the formatted duration

Params
 string $formatted_duration The formatted duration.
 int    $duration           The duration.
 string $unit               The duration unit.

Return
 string

---

Filters the labels for booking meta(s)

Params
 array $labels The labels.

Return
 array

---

Filters the label for a specific booking meta

Params
 string $label               The label.
 string $key                 The key.
 array  $booking_meta_labels The booking meta labels.

Return
 string

---

Filters the duration label

Params
 string $label         The label.
 int    $duration      The duration.
 string $duration_unit The duration unit.
 string $mode          The mode (allowed values: duration | unit | period).

Return
 string

---

Filters the duration label string

Params
 string      $label         The label.
 string      $duration_unit Duration unit.
 bool        $plural        Plural flag.
 bool|string $mode          The mode (allowed values: duration | unit | period).

Return
 string

---

includes/functions.yith-wcbk-product.php

Filters the CSS classes for availability-per-unit in calendar

Params
 string[]           $classes      The label.
 array              $availability The availability info array.
 WC_Product_Booking $product      The product.

Return
 string[]

---

Filters the minimum date when retrieving the booking form date information

Params
 string             $min_date The value.
 WC_Product_Booking $product  The product.
 array              $args     Arguments.

Return
 string

---

Filters the maximum date when retrieving the booking form date information

Params
 string             $min_date The value.
 WC_Product_Booking $product  The product.
 array              $args     Arguments.

Return
 string

---

Filters the price to be displayed

Params
 string     $price_to_display The value.
 WC_Product $product          Booking product.
 string     $price            The price.
 bool       $allow_negative   Allow negative price flag.

Return
 string

---

Filters the options for costs included in shown price

Params
 array $options The options.

Return
 array

---

includes/functions.yith-wcbk-rest.php

Filters the permission check in REST API

Params
 boolean $permission  True if it has permission; False otherwise.
 string  $context     The REST context (create, read, update, delete).
 string  $object_type The object type.

Return
 boolean

---

includes/integrations/plugins/wpml/class-yith-wcbk-wpml-booking.php

Filters the product id to be translated (if you need to translate it)

Params
 int $product_id The args.

Return
 int

---

plugin-options/configuration-options.php

Filters the sub-tabs of the Configuration panel page

Params
 array $sub_tabs The sub-tabs.

Return
 array

---

Filters the options of the Configuration panel page

Params
 array $options The options.

Return
 array

---

plugin-options/configuration/availability-rules-options.php

Filters the options of the Availability Rules panel page

Params
 array $options The options.

Return
 array

---

plugin-options/configuration/price-rules-options.php

Filters the options of the Price Rules panel page

Params
 array $options The options.

Return
 array

---

plugin-options/dashboard-options.php

Filters the options of the Dashboard panel page

Params
 array $options The options.

Return
 array

---

plugin-options/meta-boxes/search-form-options.php

Filters the option fields of the search form meta-box

Params
 array $options The options.

Return
 array

---

plugin-options/settings-options.php

Filters the sub-tabs of the Settings panel page

Params
 array $sub_tabs The sub-tabs.

Return
 array

---

Filters the options of the Settings panel page

Params
 array $options The options.

Return
 array

---

plugin-options/settings/booking-forms-options.php

Filters the options of the Booking Forms panel page

Params
 array $options The options.

Return
 array

---

plugin-options/settings/calendars-options.php

Filters the options of the Calendars panel page

Params
 array $options The options.

Return
 array

---

plugin-options/settings/customization-options.php

Filters the options of the Customization panel page

Params
 array $options The options.

Return
 array

---

plugin-options/tools-options.php

Filters the options of the Tools panel page

Params
 array $options The options.

Return
 array

---

plugin-options/tools/logs-options.php

Filters the options of the Logs panel page

Params
 array $options The options.

Return
 array

---

plugin-options/tools/tools-options.php

Filters the options of the Tools > Tools panel page

Params
 array $options The options.

Return
 array

---

templates/booking/booking-actions.php

Filters the booking actions

Params
 array             $actions The booking actions.
 YITH_WCBK_Booking $booking The booking.

Return
 array

---

templates/booking/booking-details.php

Filters order id in booking details

Params
 int               $order_id The order id.
 YITH_WCBK_Booking $booking  The booking.

Return
 int

---

templates/booking/pdf/booking-details.php

Filters order id in booking details in PDF

Params
 int               $order_id The order id.
 YITH_WCBK_Booking $booking  The booking.
 bool              $is_admin True if this is an admin PDF; false otherwise.

Return
 int

---

templates/booking/pdf/booking.php

Filters the font family used in PDF

Params
 string $font_family The font family.

Return
 string

---

templates/booking/pdf/header.php

Filters the logo URL in PDF

Params
 string $logo_url The URL.

Return
 string

---

templates/booking/pdf/user-info.php

Filters if showing user info in booking PDF only for admin

Params
 bool $show True to show the info; false otherwise.

Return
 bool

---

templates/emails/email-booking-details.php

Filters order id in booking details in emails

Params
 int               $order_id      The order id.
 YITH_WCBK_Booking $booking       The booking.
 bool              $sent_to_admin True if this is an admin email; false otherwise.
 bool              $plain_text    True if this is a plain email; false otherwise.
 YITH_WCBK_Email   $email         The email.

Return
 int

---

templates/emails/plain/email-booking-details.php

Filters order id in booking details in emails

Params
 int               $order_id      The order id.
 YITH_WCBK_Booking $booking       The booking.
 bool              $sent_to_admin True if this is an admin email; false otherwise.
 bool              $plain_text    True if this is a plain email; false otherwise.
 YITH_WCBK_Email   $email         The email.

Return
 int

---

templates/myaccount/bookings-table.php

Filters the columns of the table shown in My Account > Bookings

Params
 array $columns The columns.

Return
 array

---

templates/myaccount/bookings.php

Filters the 'bookings' endpoint

Params
 string $endpoint The endpoint.

Return
 string

---

templates/printer/types/time-select.php

Filters the minute step for the time-select

Params
 int $step The step in minutes.

Return
 int

---

templates/single-product/add-to-cart/bookable.php

Filters if showing the bookable status message in the booking form

Params
 bool $show True to show the message; false otherwise.

Return
 bool

---

Filters the bookable status message in booking form

Params
 string             $bookable_text The text.
 bool               $bookable      True if the product is bookable; false otherwise.
 int                $from          The 'from' timestamp.
 int                $to            The 'to' timestamp.
 WC_Product_Booking $product       The product.

Return
 string

---

Filters the non-available reasons

Params
 string             $non_available_reasons_html The text.
 array              $non_available_reasons      The reasons.
 int                $from                       The 'from' timestamp.
 int                $to                         The 'to' timestamp.
 WC_Product_Booking $product                    The product.

Return
 string

---

templates/single-product/add-to-cart/booking-form/dates/duration.php

Filters the duration label in booking form

Params
 string             $duration_label The label.
 WC_Product_Booking $product        The product.

Return
 string

---

templates/single-product/add-to-cart/booking.php

Filters if showing the booking form

Params
 bool $show True to show it; false otherwise.

Return
 int

---

views/calendar/html-booking-calendar-booking-list.php

Filters the bookings shown in admin calendar

Params
 YITH_WCBK_Booking_Abstract[] $bookings The bookings.

Return
 YITH_WCBK_Booking_Abstract[]

---

Filters the booking title shown in admin calendar

Params
 string            $formatted_name The title.
 YITH_WCBK_Booking $booking        The booking.

Return
 string

---

views/calendar/html-booking-calendar-single-booking-data.php

Filters the title shown in booking data in admin calendar

Params
 string            $title   The title.
 YITH_WCBK_Booking $booking The booking.

Return
 string

---

views/create-booking.php

Filters the default selected value for 'assign booking' option when creating a booking manually

Params
 string $value The value.

Return
 string

---

views/metaboxes/html-booking-meta-data.php

Filters if showing the calculated amount for the booking (admin side)

Params
 bool              $show    True to show; false otherwise.
 YITH_WCBK_Booking $booking The booking.

Return
 bool

---

views/product-tabs/html-settings-tab.php

Filters the custom attributes for the 'buffer' option field shown in product settings on admin side

Params
 string $custom_attributes The custom attributes.

Return
 string

---