Development

includes/abstracts/class-yith-wcaf-abstract-admin-email.php

Filters the email recipient for the admin emails.
$id will be replaced with the email id

Params
 string $recipient Email recipient.

---

includes/abstracts/class-yith-wcaf-abstract-admin-panel.php

Filters the url for the current tab in the backend

Params
 string $url Tab url.

---

Filters the screen id for the current tab in the plugin panel.
$tab will be replaced with the current tab in the plugin panel

Params
 string $screen_id Screen id for current tab.

---

Filters the array with the variables to localize into the plugin script.
$tab will be replaced with the current tab in the plugin panel

Params
 array $localize Array with variables to localize.

---

includes/abstracts/class-yith-wcaf-abstract-admin-table.php

Filters the content of the default column in the table in the backend.
$plural will be replaced with the plural form of the item in the table

Params
 YITH_WCAF_Abstract_Object $item        Item of the row.
 string                    $column_name Column name.

---

Filters the content of the affiliate column in the table in the backend

Params
 string                    $column Column content.
 YITH_WCAF_Abstract_Object $item   Current item row.

---

Filters the content of the amount column in the table in the backend

Params
 string                    $column Column content.
 YITH_WCAF_Abstract_Object $item   Current item row.

---

Filters the list with the CSS clasees for the table in the backend

Params
 array                          $classes     List of CSS classes.
 YITH_WCAF_Abstract_Admin_Table $admin_table Admin table object.

---

Filters the label to be used for a specific view in the table in the backend.
$plural will be replaced with the plural form of the item in the table

Params
 string $view  View slug.
 int    $count Count of items in the view (to choose between singular/plural).

---

includes/abstracts/class-yith-wcaf-abstract-dashboard.php

Filters whether the endpont is availabe for guest users

Params
 bool   $is_available Whether endpoint is available for guest users or not.
 string $endpoint     Endpoint to test.

---

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

Filters the custom sections in the Affiliate Dashboard

Params
 string $custom_sections Custom sections.
 array  $query_vars      Query vars.
 array  $atts            Array of attributes.

---

Filters the additional notes in the modal to request a withdraw

Params
 string $notes Additional notes.

---

Filters the payment notice in the Affiliate Dashboard page

Params
 string $payment_notice Payment notice.

---

Filters the CSS classes for the payment notice in the Affiliate Dashboard page

Params
 array  $classes       CSS classes.
 array  $message_parts Array with the parts of the message.
 string $message       Message.

---

Filters whether to use pretty urls in the affiliate dashboard pages

Params
 string $permalink_structure Permalink structure.

---

Filters the endpoint url in the affiliate dashboard

Params
 string $url       Endpoint url.
 string $endpoint  Endpoint key.
 string $value     Affiliate dashboard url.
 string $permalink Dashboard base url.

---

Filters whether the user can see a specific section in the Affiliate Dashboard

Params
 bool   $can_see  Whether the user can see a specific section or not.
 int    $user_id  User id.
 string $endpoint Endpoint.

---

Filters the links for the sections in the Affiliate Dashboard

Params
 array $dashboard_links Dashboard links.

---

Filters whether to show the link to the dashboard section in the Affiliate Dashboard

Params
 bool $show_dashboard_link Whether to show the link to the dashboard section or not.

---

Filters the elements of the navigation menu in the Affiliate Dashboard

Params
 array $navigation_menu Array with elements in the navigation menu.

---

includes/abstracts/class-yith-wcaf-abstract-email.php

Filters the trigger of the email

Params
 string                   $trigger Email trigger.
 YITH_WCAF_Abstract_Email $email   Email object.

---

includes/abstracts/class-yith-wcaf-abstract-gateway.php

Filters the name of the payment gateway.
$id will be replaced with the id of the payment gateway

Params
 string $name Name of the payment gateway.

---

Filters whether the gateway supports a specific capability.
$id will be replaced with the id of the payment gateway.
$capability will be replaced with the capability to test

Params
 bool                       $suports    Whether the gateway supports a specific capability or not.
 YITH_WCAF_Abstract_Gateway $gateway    Gateway object.
 string                     $gateway_id Gateway id.

---

Filters whether the gateway can be used to pay an affiliate.
$id will be replaced with the id of the payment gateway

Params
 bool                       $can_be_used Whether the gateway can be used to pay an affiliate or not.
 YITH_WCAF_Affiliate        $affiliate   Affiliate object.
 YITH_WCAF_Abstract_Gateway $gateway     Gateway object.
 string                     $gateway_id  Gateway id.

---

Filters the fields defined for the payment gateway.
$id will be replaced with the id of the payment gateway

Params
 array                      $fields     Gateway fields.
 YITH_WCAF_Abstract_Gateway $gateway    Gateway object.
 string                     $gateway_id Gateway id.

---

Filters the value of a specific option for the gateway.
$id will be replaced with the id of the payment gateway

Params
 string                     $value      Option value.
 array                      $option     Option.
 YITH_WCAF_Abstract_Gateway $gateway    Gateway object.
 string                     $gateway_id Gateway id.

---

Filters the gateway settings.
$id will be replaced with the id of the payment gateway

Params
 array                      $options    Array of options.
 YITH_WCAF_Abstract_Gateway $gateway    Gateway object.
 string                     $gateway_id Gateway id.

---

includes/abstracts/class-yith-wcaf-abstract-object-factory.php

Filters the class name used when creating the object for a specific id.
$object_type will be replaced with current object type, depending on class implementation

Params
 string $class Class name.
 int    $id    ID of the object.

---

includes/abstracts/class-yith-wcaf-abstract-object.php

Filters the list of the actions to perform over the current object

Params
 array                     $admin_actions Actions to perform over the object.
 int                       $object_id     Object id.
 YITH_WCAF_Abstract_Object $object        Current object to perform actions.

---

Filters the generated array with the data from the object

Params
 array                     $data      Object data.
 int                       $object_id Object id.
 YITH_WCAF_Abstract_Object $object    Current object to perform actions.

---

Filters whether the user is the owner of the current object.
$object_type will be replaced with the object type the operation will be performed to

Params
 bool                      $is_owner  Whether the user is the owner of the current object or not.
 int                       $user_id   User id.
 int                       $owner_id  Owner id.
 int                       $object_id Object id.
 YITH_WCAF_Abstract_Object $object    Current object to perform actions.

---

Filters whether the user can perform operations over current payment.
$object_type will be replaced with the object type the operation will be performed to

Params
 bool   $can        Whether the user can perform operations or not.
 int    $user_id    User id.
 string $capability Capability to check.
 int    $id         Object id to check.
 object $object     Object to check.

---

includes/abstracts/class-yith-wcaf-abstract-rest-crud-controller.php

Filters the array with the parameters to get the collections.
$object will b replaced with the object to get the collections

Params
 array $params Array with parameters.

---

includes/abstracts/class-yith-wcaf-abstract-rest-reports-controller.php

Filters the report returned from the API

Params
 WP_REST_Response $response The response object.
 object           $object   The original report object.
 WP_REST_Request  $request  Request used to generate the response.

---

includes/abstracts/class-yith-wcaf-abstract-shortcode.php

Filters the attributes for the shortcode.
$tag will be replaced with the shortcode tag

Params
 array $atts Shortcode attributes.

---

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

Filters the shortcode configuration for the integration with the builder.
$tag will be replaced with the shortcode tag.
$builder will be replaced with the builder name

Params
 array $shortcode_config Shortcode configuration.

---

Filters the shortcode attributes for the integration with the builder.
$tag will be replaced with the shortcode tag.
$builder will be replaced with the builder name

Params
 array $shortcode_atts Shortcode attributes.

---

includes/admin/admin-panels/class-yith-wcaf-affiliates-admin-panel-premium.php

Filters the array with the headings to export the affiliates into CSV

Params
 array                           $csv_heading Array with the headings for the CSV export.
 YITH_WCAF_Affiliates_Collection $affiliates  Collection of the affiliates to export.

---

Filters the array with the affiliate info to export into CSV

Params
 array $affiliate_info Affiliate info to export.
 array $headings       Array with the headings for the CSV export.

---

includes/admin/admin-panels/class-yith-wcaf-clicks-admin-panel.php

Filters the url for the current tab in the backend

Params
 string $url Tab url.

---

includes/admin/admin-panels/class-yith-wcaf-commissions-admin-panel-premium.php

Filters the array with the headings to export the commissions into CSV

Params
 array                            $csv_heading Array with the headings for the CSV export.
 YITH_WCAF_Commissions_Collection $commissions  Collection of the commissions to export.

---

Filters the array with the commission info to export into CSV

Params
 array $row      Commission info to export.
 array $headings Array with the headings for the CSV export.

---

includes/admin/admin-panels/class-yith-wcaf-payments-admin-panel-premium.php

Filters the array with the headings to export the payments into CSV

Params
 array                         $csv_heading Array with the headings for the CSV export.
 YITH_WCAF_Payments_Collection $payments    Collection of the payments to export.

---

Filters the array with the payment info to export into CSV

Params
 array $payment_info Payment info to export.
 array $headings     Array with the headings for the CSV export.

---

includes/admin/admin-panels/class-yith-wcaf-payments-admin-panel.php

Filters the url for the current tab in the backend

Params
 string $url Tab url.

---

includes/admin/admin-panels/class-yith-wcaf-rates-admin-panel.php

Filters the url for the current tab in the backend

Params
 string $url Tab url.

---

includes/admin/admin-tables/class-yith-wcaf-affiliates-admin-table-premium.php

Filters the columns for the Affiliates table in the backend

Params
 array $columns Table columns.

---

includes/admin/admin-tables/class-yith-wcaf-commissions-admin-table-premium.php

Filters the content on the product column in the commissions table

Params
 string $column     Column content.
 int    $product_id Product ID.
 string $table_type Table type.

---

Filters the content of the category column in the commissions table

Params
 string $column     Column output.
 int    $product_id Product id.
 string $items      Items to display in the table.

---

Filters the columns for the commissions table in the backend

Params
 array $columns Table columns.

---

includes/admin/admin-tables/class-yith-wcaf-commissions-admin-table.php

Filters the output of the category column in the Commissions table

Params
 string $column     Column output.
 int    $product_id Product id.
 string $items      Items to display in the table.

---

includes/admin/admin-tables/class-yith-wcaf-payments-admin-table-premium.php

Filters the columns for the payments table in the backend

Params
 array $columns Table columns.

---

includes/admin/class-yith-wcaf-admin-meta-boxes.php

Filters the meta boxes registered in the backend

Params
 array $meta_boxes Registered meta boxes.

---

includes/admin/class-yith-wcaf-admin-profile.php

Filters the additional fields in the user profile

Params
 array $fields Profile fields.

---

Filters the maximum rate value

Params
 int $max_rate_value Maximum rate value.

---

Filters the additional gateway fields in the user profile

Params
 array $gateway_fields Gateway fields.

---

Filters whether the current user can view profile fields

Params
 bool $can_view Whether the current user can view profile fields or not.
 int  $user_id  User id.

---

Filters whether the current user can view profile details

Params
 bool $can_view Whether the current user can view profile details or not.
 int  $user_id  User id.

---

Filters whether a specific field should be printed in the user profile

Params
 bool   $should_print Whether a specific field should be printed or not.
 string $key          Key of the field.
 array  $field        Field to parse.
 string $context      Context of the operation.

---

Filters the field in the user profile

Params
 array               $field     Field to parse.
 string              $key       Key of the field.
 string              $value     Value of the field.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 WP_User             $user      User object.

---

Filters whether the current user can edit profile fields

Params
 bool $can_edit Whether the current user can edit profile fields or not.
 int  $user_id  User id.

---

includes/admin/class-yith-wcaf-admin.php

Filters the screen ids related to the plugin

Params
 array $screen_ids Screen ids.

---

Filters the url of the plugin panel

Params
 string $panel_url Plugin panel url.

---

Filters the screen id of the plugin panel

Params
 string $base_id Screen id of the plugin panel.

---

Filter the available tabs in the plugin panel

Params
 array $tabs Admin tabs.

---

Filters the minimum capability needed to manage the plugin panel

Params
 string $capability Capability.

---

Filters the array with the variables to localize into the plugin script

Params
 array $localize Array with variables to localize.

---

includes/class-yith-wcaf-affiliate.php

Filters whether affiliates is valid (can receive commissions) or not

Params
 bool                $is_valid  Whether affiliate is valid or not.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

---

Filters affiliate referral url

Params
 string $referral_url Affiliate referral url.
 string $ref_name     Name of the parameter used for referral token in url.
 string $token        Affiliate token.
 string $base_url     Url used as a base for referral url generation.

---

Filters list of users associated with an affiliate

Params
 WP_User[]|bool      $users     List of users objects, or false on failure.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

---

Filters preferences affiliate configured for a specific gateway.
$GATEWAY_ID will be replaced by the actual id of the gateway

Params
 array               $preferences Preferences configured for current gateway.
 int                 $id          Affiliate id.
 YITH_WCAF_Affiliate $affiliate   Affiliate object.

---

Filters template used to format affiliate's invoice profile
Any placeholder is included between a double pair of curly braces; following a list of available fields

• first_name


• last_name


• company


• billing_address_1


• billing_address_2


• billing_city


• billing_postcode


• billing_state


• billing_country


• cif


• vat

Params
 string $format invoice profile format template.

---

Filters affiliates formatted invoice profile HTML

Params
 string              $profile          Affiliate formatted invoice profile.
 int                 $user_id          User id.
 array               $available_fields Fields available for invoice profile, as configured by admin.
 array               $invoice_profile  Affiliate invoice profile info.
 YITH_WCAF_Affiliate $affiliate        Affiliate object.

---

Filters the available actions for each affiliate in the affiliates table

Params
 array               $actions     Actions.
 int                 $id          Affiliate id.
 YITH_WCAF_Affiliate $affiliate   Affiliate object.

---

Filters default value for notification preference
$NOTIFICATION will be replaced with specific notification name

Params
 string $default  Yes or no, depending on default value we want to assign to current notification.
 int    $user_id  User id.

---

Notification preference for current affiliate
$NOTIFICATION will be replaced with specific notification name

Params
 string              $notification Yes or no, depending on actual notification value for current affiliate notification.
 int                 $id           Affiliate id.
 YITH_WCAF_Affiliate $affiliate    Affiliate object.

---

Filters data returned when converting an affiliate object to an array

Params
 array               $array     Affiliate in array format.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

---

Filters commissions found for current affiliate, for filters passed

Params
 YITH_WCAF_Commissions_Collection $commissions  Commissions collection (may be empty).
 int                              $id           Affiliate id.
 YITH_WCAF_Affiliate              $affiliate    Affiliate object.
 array                            $args         Array of filtering criteria used for the query.

---

Filters count of commissions found for current affiliate, for current filters

Params
 int                 $count     Count of commissions found.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 array               $args      Array of filtering criteria used for the query.

---

Filters whether affiliates has unpaid commissions (and then can request payment)

Params
 bool                             $has_unpaid Whether affiliate has unpaid commissions.
 int                              $id         Affiliate id.
 YITH_WCAF_Affiliate              $affiliate  Affiliate object.
 YITH_WCAF_Commissions_Collection $unpaid     Collection of unpaid commissions found.

---

Filters commissions found for current affiliate, for filters passed

Params
 YITH_WCAF_Payments_Collection $payments  Payments collection (may be empty).
 int                           $id        Affiliate id.
 YITH_WCAF_Affiliate           $affiliate Affiliate object.
 array                         $args      Array of filtering criteria used for the query.

---

Filters count of payments found for current affiliate, for current filters

Params
 int                 $count     Count of payments found.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 array               $args      Array of filtering criteria used for the query.

---

Filters whether affiliates has active payments (and then cannot request further payment)

Params
 bool                          $has_active Whether affiliate has active payments.
 int                           $id         Affiliate id.
 YITH_WCAF_Affiliate           $affiliate  Affiliate object.
 YITH_WCAF_Payments_Collection $active     Collection of active payments found.

---

Filters whether affiliates can withdraw (has unpaid commissions and no active payment, balance is enough)

Params
 bool                             $can_withdraw Whether affiliate can withdraw.
 int                              $id          Affiliate id.
 YITH_WCAF_Affiliate              $affiliate   Affiliate object.

---

Filters clicks found for current affiliate, for filters passed

Params
 YITH_WCAF_Clicks_Collection $clicks    Clicks collection (may be empty).
 int                         $id        Affiliate id.
 YITH_WCAF_Affiliate         $affiliate Affiliate object.
 array                       $args      Array of filtering criteria used for the query.

---

Filters count of clicks found for current affiliate, for current filters

Params
 int                 $count     Count of clicks found.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 array               $args      Array of filtering criteria used for the query.

---

Filters count of coupons found for current affiliate

Params
 int                 $count     Count of coupons found.
 int                 $id        Affiliate id.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

---

Filters the maximum rate value

Params
 int $max_rate_value Maximum rate value.

---

includes/class-yith-wcaf-affiliates-invoice-profile.php

Filters the billing fields for the invoice

Params
 array $invoice_fields Billing fields for the invoice.

---

Filters whether to show all fields in the form to withdraw amount

Params
 bool $show_all_fields Whether to show all fields in the form or not.

---

Filters the billing field in the form

Params
 bool   $billing_field Billing field.
 string $field_id      Field id.
 array  $fields        Fields.

---

Filters the label for the invoice field.
$field_key will be replaced with the key for each field

Params
 string $label Field label.
 array  $field Field.

---

Filters whether the invoice field will be required.
$field_key will be replaced with the key for each field

Params
 bool  $is_field_required Whether the field is required or not.
 array $field Field.

---

includes/class-yith-wcaf-affiliates-premium.php

Filters whether the user is an excluded affiliate

Params
 bool $is_excluded Whether the user is an excluded affiliate or not.
 int  $user_id     User id.

---

includes/class-yith-wcaf-affiliates-profile.php

Filters the supported field types

Params
 array $field_types Supported field types.

---

Filters the supported field validations

Params
 array $field_validations Supported field validations.

---

Filters the supported field locations

Params
 array $field_locations Supported field locations.

---

Filters the field type.
$field_key will be replaced with the key for each field

Params
 string $field_type Field type.
 array  $field      Field.

---

Filters the field label.
$field_key will be replaced with the key for each field

Params
 string $field_label Field label.
 array  $field       Field.

---

Filters whether the field will be required.
$field_key will be replaced with the key for each field

Params
 bool  $is_field_required Whether the field is required or not.
 array $field             Field.

---

Filters the field value.
$field_key will be replaced with the key for each field

Params
 string              $field_value Field value.
 YITH_WCAF_Affiliate $affiliate   Affiliate object.
 string              $context     Context of the operation.

---

Filters the fields in the affiliate's profile

Params
 array $fields Fields.

---

Filters the enabled fields in the affiliate's profile

Params
 array $fields Enabled fields.
 array $args   Array with arguments.

---

Filters the fields to show in the form to become an affiliate

Params
 array $fields Fields.
 array $args   Array with arguments.

---

Filters the fields to show in the settings form

Params
 array $fields Fields.
 array $args   Array with arguments.

---

includes/class-yith-wcaf-affiliates.php

Filters the available statuses for the affiliates

Params
 array $available_statuses Available statuses.

---

Filters the name of the affiliate's status

Params
 string $label  Status name.
 string $status Status.

---

Filters whether the token is valid

Params
 bool   $is_valid_token Whether the token is valid or not.
 string $token          Token.

---

Filters whether the user is an affiliate

Params
 bool $is_affiliate Whether the user is an affiliate or not.
 int  $user_id      User id.

---

Filters whether the user is an enabled affiliate

Params
 bool $is_enabled_affiliate Whether the user is an enabled affiliate or not.
 int  $user_id              User id.

---

Filters whether the user is a pending affiliate

Params
 bool $is_pending_affiliate Whether the user is a pending affiliate or not.
 int  $user_id              User id.

---

Filters whether the user is a rejected affiliate

Params
 bool $is_rejected_affiliate Whether the user is a rejected affiliate or not.
 int  $user_id               User id.

---

Filters whether the user is a valid affiliate (enabled and not banned)

Params
 bool $is_valid_affiliate Whether the user is a valid affiliate or not.
 int  $user_id            User id.

---

Filters whether the user is a banned affiliate

Params
 bool $is_banned_affiliate Whether the user is a banned affiliate or not.
 int  $user_id             User id.

---

includes/class-yith-wcaf-ajax-handler-premium.php

Filters the AJAX handlers

Params
 array $ajax_handlers AJAX handlers.

---

Filters the error message when the token is missing

Params
 string $error_message Error message.

---

Filters the error message when the token is not valid

Params
 string $error_message Error message.

---

Filters the success message when the token not valid

Params
 string $success_message Success message.

---

includes/class-yith-wcaf-ajax-handler.php

Filters the AJAX handlers

Params
 array $ajax_handlers AJAX handlers.

---

Filters the AJAX handler action

Params
 string $action  AJAX handler action.
 string $handler AJAX handler.

---

Filters whether current user can get the referral URL

Params
 bool $can_get_referral_url Whether current user can get referral URL or not.
 int  $current_user_id      Current user ID.

---

includes/class-yith-wcaf-blocks.php

Filters the available blocks

Params
 array $blocks Available blocks.

---

includes/class-yith-wcaf-checkout.php

Filters whether to avoid auto-commissions for the affiliate

Params
 bool                $avoid_auto_commission Whether to avoid auto-commissions or not.
 YITH_WCAF_Affiliate $affiliate             Affiliate object.

---

Allows to create commissions on checkout order processed

Params
 bool     $process Whether to process commissions or not.
 WC_Order $order   Order object.

---

includes/class-yith-wcaf-clicks.php

Filters the available statuses for the clicks

Params
 array $available_statuses Available statuses.

---

Filters the name of the click status

Params
 string $label  Status name.
 string $status Status.

---

Filters whether clicks should be registered

Params
 bool $register_hits Whether to register clicks or not.

---

Filters the user IP address for the click

Params
 string $requester_ip Requester IP address.

---

Filters the URL visited by the current requester

Params
 string $requester_url Visited URL.

---

Filters the origin URL for the current requester

Params
 string $origin Origin URL.

---

includes/class-yith-wcaf-commission.php

Filters the label for the commission status.
$current_status will be replaced with the commission status

Params
 string $label The commission status label.

---

Filters the available actions for each commission in the commissions table

Params
 array                $actions    Actions.
 int                  $id         Commission id.
 YITH_WCAF_Commission $commission Commission object.

---

Filters data returned when converting a commission object to an array

Params
 array                $array      Commission in array format.
 int                  $id         Commission id.
 YITH_WCAF_Commission $commission Commission object.

---

Filters payments found for current commission, for filters passed

Params
 YITH_WCAF_Payments_Collection $payments   Payments collection (may be empty).
 int                           $id         Commission id.
 YITH_WCAF_Commission          $commission Commission object.
 array                         $args       Array of filtering criteria used for the query.

---

Filters active payments found for current commission

Params
 YITH_WCAF_Payments_Collection $payments   Payments collection (may be empty).
 int                           $id         Commission id.
 YITH_WCAF_Commission          $commission Commission object.

---

Filters inactive payments found for current commission

Params
 YITH_WCAF_Payments_Collection $payments   Payments collection (may be empty).
 int                           $id         Commission id.
 YITH_WCAF_Commission          $commission Commission object.

---

Filters the maximum rate value

Params
 int $max_rate_value Maximum rate value.

---

includes/class-yith-wcaf-commissions.php

Filters the available statuses for the commissions

Params
 array $available_statuses Available statuses.

---

Filters the available status changes for commissions

Params
 array $available_status_changes Array of valid status changes.

---

Filters the name of the commission status

Params
 string $label  Status name.
 string $status Status.
 int    $count  Count of items.

---

Filters the unassigned statuses for commissions

Params
 array $unassigned_statuses Array of unassigned statuses.

---

Filters the assigned statuses for commissions

Params
 array $assigned_statuses Array of assigned statuses.

---

Filters the payment statuses for commissions

Params
 array $payment_statuses Array of payment statuses.

---

Filters the dead statuses for commissions

Params
 array $dead_statuses Array of dead statuses.

---

includes/class-yith-wcaf-compatibilities.php

Filters the available plugin compatibilities

Params
 array $compatibilities Available compatibilities.

---

includes/class-yith-wcaf-coupons.php

Filters whether the coupon management is enabled for affiliates

Params
 bool $coupons_enabled Whether the coupon management is enabled or not.

---

Filters whether to show the coupon section in the Affiliate Dashboard

Params
 bool $show_coupon_section Whether to show coupon section or not.

---

Filters the parameter used in the query string to trigger the apply promo handling

Params
 string $parameter Query string parameter.

---

includes/class-yith-wcaf-crons-handler-premium.php

Filters the registered crons

Params
 array $crons Registered crons.

---

includes/class-yith-wcaf-crons-handler.php

Filters the registered crons

Params
 array $crons Registered crons.

---

includes/class-yith-wcaf-emails.php

Filters the available emails

Params
 array $emails Available emails.

---

includes/class-yith-wcaf-endpoints.php

Filters the available endpoints in the Affiliate Dashboard

Params
 array $available_endpoints Available endpoints.

---

Filters the available dashboard endpoints

Params
 array $available_endpoints Available endpoints.

---

Filters the rewrite for a specific endpoint

Params
 string $endpoint Endpoint rewrite.

---

Filters the available endpoints in the Affiliate Dashboard

Params
 array $available_endpoints Available endpoints.

---

includes/class-yith-wcaf-form-handler-premium.php

Filters the form handlers

Params
 array $handlers Form handlers.

---

includes/class-yith-wcaf-form-handler.php

Filters the form handlers

Params
 array $handlers Form handlers.

---

Filters the validation errors when registering a new affiliate

Params
 WP_Error $validation_errors Error object.

---

Filters whether to redirect to the Affiliate Dashboard after registration

Params
 bool $redirect_to_dashboard Whether to redirect to dashboard after registration or not.

---

Filters the URL to redirect after registration

Params
 string $redirect URL to redirect.

---

Filters the URL to redirect after sending the application to become an affiliate

Params
 string $redirect URL to redirect.

---

Filters the generated URL in the link generator

Params
 string $referral_url Referral URL.

---

includes/class-yith-wcaf-gateways.php

Filters the payment gateways

Params
 array $payment_gateways Payment gateways.

---

Filters the available legacy gateways

Params
 array $legacy_gateways Legacy gateways.

---

Filters the label of the payment gateway field.
$gateway_id will be replaced with the id of the payment gateway.
$field_key will be replaced with the key of the field

Params
 string $field_label Field label.
 array  $field       Field.

---

Filters whether the gateway field is required.
$gateway_id will be replaced with the id of the payment gateway.
$field_key will be replaced with the key of the field

Params
 bool  is_required Whether the field is required or not.
 array $field      Field.

---

includes/class-yith-wcaf-instance.php

Filters the current instance (url of the site where the plugin is currently running on)

Params
 string $instance Current instance url.

---

Filters whether the current instance matches the registered one

Params
 bool   $match               Whether the current instance matches the registered one or not.
 string $current_instance    Current instance.
 string $registered_instance Registered instance.

---

includes/class-yith-wcaf-invoices.php

Filters the fields used to create the invoice

Params
 array $invoice_fields Fields used to create the invoice.

---

Filters whether invoices are required to perform a withdraw

Params
 bool $invoice_required Whether invoices are required or not.

---

Filters the url to get the invoice

Params
 string $invoice_url Invoice url.
 int    $payment_id  Payment id.

---

Filters the url to download the invoice

Params
 string $invoice_url Invoice url.
 int    $payment_id  Payment id.

---

Filters the path to get the invoice

Params
 string $invoice_path Invoice path.
 int    $payment_id   Payment id.

---

Filters the array with the arguments sent to the template to generate the payment invoice

Params
 array $args Array of arguments.
 YITH_WCAF_Payment $payment Payment object.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

Return
 array

---

Filters the affiliate landing in the invoice

Params
 string $affiliate_landing Affiliate landing.

---

Filters the currency to be used in the invoice

Params
 string $currency Currency.

---

Filters the invoice title

Params
 string $invoice_title Invoice title.

---

Filters the invoice description

Params
 string $invoice_description Invoice description.

---

Filters the affiliate program name in the invoice

Params
 string $affiliate_program Affiliate program name.

---

Filters the Invoice number for current document

Params
 string            $value      Value.
 int               $payment_id Payment ID.
 YITH_WCAF_Payment $payment    Payment object.

---

Filters the replaced value for the invoice field

Params
 string            $value      Value.
 array             $field      Field.
 array             $args       Array of arguments.
 int               $payment_id Payment ID.
 YITH_WCAF_Payment $payment    Payment object.

---

includes/class-yith-wcaf-orders-premium.php

Filters whether to create the order commissions

Params
 bool   $create_commissions Whether to create commissions or not.
 int    $order_id           Order id.
 string $token              Referral token.
 string $token_origin       Referral token origin.

---

Allow to skip creation of commissions with amount 0

Params
 bool $skip_zero_commissions Whether to skip 0 commissions or not (default: true).

---

Filters whether to use the current date for the commission when it is created

Params
 bool $use_current_date Whether to use the current date for the commission, use the order created date when false.

---

Filters whether to create the commissions for the order item

Params
 bool                  $create_commission Whether to create commission for the order item or not.
 WC_Order_Item_Product $item              Order item object.
 int                   $item_id           Order item id.
 int                   $product_id        Product id.
 array                 $commission_args   Array of arguments for the commission generation.

---

Filters whether create commissions for specific products

Params
 bool   $create_product_commission Whether to create commissions for products or not.
 int    $product_id                Product id.
 int    $order_id                  Order id.
 string $token                     Referral token.
 string $token_origin              Referral token origin.

---

includes/class-yith-wcaf-orders.php

Filters the commission status

Params
 string $commission_status Commission status.
 string $order_status      Order status.

---

Filters the default commission status

Params
 string $default_status Default commission status.
 string $order_status   Order status.

---

Filters whether to create the order commissions

Params
 bool   $create_commissions Whether to create commissions or not.
 int    $order_id           Order id.
 string $token              Referral token.
 string $token_origin       Referral token origin.

---

Allow to skip creation of commissions with amount 0

Params
 bool $skip_zero_commissions Whether to skip 0 commissions or not (default: true).

---

Filters whether to use the current date for the commission when it is created

Params
 bool $use_current_date Whether to use the current date for the commission, use the order created date when false.

---

Filters whether to create the commissions for the order item

Params
 bool                  $create_commission Whether to create commission for the order item or not.
 WC_Order_Item_Product $item              Order item object.
 int                   $item_id           Order item id.
 int                   $product_id        Product id.
 array                 $commission_args   Array of arguments for the commission generation.

---

Filters the item amount used to calculate the commission

Params
 float                 $item_amount   Item amount to calculate commission.
 WC_Order              $order         Order object.
 int                   $order_item_id Order item id.
 WC_Order_Item_Product $line_item     Order item object.
 float                 $rate          Commission rate.

---

Filters whether to use percentage rates in the commissions system

Params
 bool $use_percentage_rates Whether to use percentage rates for the commissions, fixed amounts when false.

---

Filters whether to check if the commission amount is greater than the line item total

Params
 bool $check_total_amount Whether to check if the commission amount is greater than the line item total or not.

---

Filters the generated commission amount

Params
 float                  $amount               Commission amount.
 WC_Order               $order                Order object.
 int                    $line_item_id         Order item id.
 WC_Order_Item_Product  $line_item            Order item object.
 float                  $rate                 Commission rate.
 bool                   $use_percentage_rates Whether to use percentage rate to calculate commissions.

---

Filters whether create commissions for specific products

Params
 bool   $create_product_commission Whether to create commissions for products or not.
 int    $product_id                Product id.
 int    $order_id                  Order id.
 string $token                     Referral token.
 string $token_origin              Referral token origin.

---

Filters whether the commissions will be calculated excluding taxes

Params
 bool $exclude_tax Whether to exclude tax or not.

---

Filters whether the commissions will be calculated excluding order discounts

Params
 bool $exclude_discounts Whether to exclude discount or not.

---

includes/class-yith-wcaf-payment.php

Filters whether the current payment can be paid

Params
 bool              $can_be_paid Whether the payment can be paid or not.
 YITH_WCAF_Payment $payment     Payment object.
 int               $id          Payment id.

---

Filters the available actions for each payment in the payments table

Params
 array             $actions Actions.
 int               $id      Payment id.
 YITH_WCAF_Payment $payment Payment object.

---

Filters whether the user can perform operations over current payment.
$object_type will be replaced with the object type the operation will be performed to

Params
 bool   $can        Whether the user can perform operations or not.
 int    $user_id    User id.
 string $capability Capability to check.

---

includes/class-yith-wcaf-payments-premium.php

Filters whether is possible to proceed with the payment

Params
 bool              $proceed_with_payment Whether to proceed with the payment or not.
 int               $payment_id           Payment id.
 YITH_WCAF_Payment $payment              Payment object.
 string            $gateway_id           Gateway id to use for payments.

---

Filters the array of arguments to pay the commissions

Params
 array $args Array of arguments.

---

includes/class-yith-wcaf-payments.php

Filters the available statuses for the payments

Params
 array $available_statuses Available statuses.

---

Filters the name of the payment status

Params
 string $label  Status name.
 string $status Status.

---

Filters the inactive statuses for payments

Params
 array $inactive_statuses Array of inactive statuses.

---

Filters the active statuses for payments

Params
 array $active_statuses Array of active statuses.

---

Filters the pending statuses for payments

Params
 array $pending_statuses Array of pending statuses.

---

Filters the completed statuses for payments

Params
 array $completed_statuses Array of completed statuses.

---

Filters the paid statuses for payments

Params
 array $payment_statuses Array of paid statuses.

---

Filters the available status changes for payments

Params
 array $available_status_changes Array of valid status changes.

---

includes/class-yith-wcaf-privacy.php

Filter the content of the privacy policy

Params
 string $content Privacy policy content
 string $section Privacy policy section

Return
 string

---

Filters whether to register the commissions exporter

Params
 bool $register_exporter Whether to register commissions exporter or not.

---

Filters whether to register the payments exporter

Params
 bool $register_exporter Whether to register payments exporter or not.

---

Filters whether to register the clicks exporter

Params
 bool $register_exporter Whether to register clicks exporter or not.

---

Filters whether to register the payments eraser

Params
 bool $register_eraser Whether to register payments eraser or not.

---

Filters whether to register the clicks eraser

Params
 bool $register_eraser Whether to register clicks eraser or not.

---

Filters the affiliate's personal data props to export

Params
 array $data_to_export Personal data to export.

---

Filters the commission props to export

Params
 array $commission_props Commission props to export.

---

Filters the payment props to export

Params
 array $payment_props Payment props to export.

---

Filters the click props to export

Params
 array $click_props Click props to export.

---

Filters the affiliate's personal data props to remove

Params
 array $data_to_remove Personal data to remove.

---

Filters the payment props to remove

Params
 array $payment_props Payment props to remove.

---

Filters the click props to remove

Params
 array $click_props Click props to remove.

---

Filters the object prop to export

Params
 string $value  Prop value to export.
 string $prop   Prop to export.
 object $object Object to export.

---

Filters the personal data of the object to export

Params
 array  $personal_data Personal data to export.
 object $object        Object to export.

---

Filters whether to remove the object data

Params
 bool   $erase_object_data Whether to remove the object data or not.
 object $object            Object to remove data from.

---

Filters the object prop to remove

Params
 string $anon_value Prop value to remove.
 string $prop       Prop to export.
 string $value      Value to remove.
 string $data_type  Data type.
 object $object     Object.

---

includes/class-yith-wcaf-promo.php

Filters the parameter used in the url to trigger the apply promo handling

Params
 string $apply_promo_param Param used in the url.

---

Filters whether to add the referral token to the url to apply the coupon code

Params
 bool $add_referral_token Whether to add the referral token to the apply promo url or not.

---

Filters the url to apply automatically the coupon code

Params
 string $apply_promo_url Url to apply the coupon code.
 string $coupon_code     Coupon code.

---

Filters the saved promo in the cookie

Params
 string $saved_promo Saved promo.

---

Filters whether to set the promo cookie

Params
 bool $set_promo_cookie Whether to set promo cookie or not.

---

Filters the message shown when the affiliate's coupon code is applied

Params
 string              $new_message New message.
 WC_Coupon           $coupon      Coupon object.
 YITH_WCAF_Affiliate $affiliate   Affiliate object.

---

includes/class-yith-wcaf-rate-handler-premium.php

Filters the affiliate rate

Params
 float               $rate      Affiliate rate.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 WC_Product          $product   Product object.
 WC_Order            $order     Order object.

---

Filters the persistent rate

Params
 float                 $persistent_rate Persistent rate.
 string                $token           Affiliate token.
 WC_Order_Item_Product $item            Order item object.

---

Params
 array                    $conditions_sets Array of conditions sets used to search rules' DB.
 YITH_WCAF_Affiliate|bool $affiliate       Affiliate object.
 WC_Product|bool          $product         Product object.

---

Filters whether the rule fits search parameters

Params
 bool                $match     Whether the rule fits search parameters or not.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 WC_Product          $product   Product object.

---

includes/class-yith-wcaf-rate-handler.php

Filters the default rate

Params
 float $general_rate Default rate.

---

Filters the affiliate rate

Params
 float               $rate      Affiliate rate.
 YITH_WCAF_Affiliate $affiliate Affiliate object.
 WC_Product          $product   Product object.
 WC_Order            $order     Order object.

---

includes/class-yith-wcaf-rate-rule.php

Filters the maximum rate value

Params
 int $max_rate_value Maximum rate value.

---

includes/class-yith-wcaf-session-premium.php

Filters whether to apply the persistent token

Params
 bool   $apply_persistent_token Whether to apply persisten token or not.
 int    $current_user_id        Current user id.
 string $persistent_token       Persistent token.
 string $token                  Referral token.
 string $token_origin           Token origin.

---

Filters the history cookie name

Params
 string $history_cookie_name History cookie name.

---

Filters whether the history cookie has been set

Params
 bool $has_history_cookie Whether the history cookie is set or not.

---

includes/class-yith-wcaf-session.php

Filters the parameter used in the url to store the referral token

Params
 string $param Parameter to store the referral token.

---

Filters the value stored in the query string for the referral token

Params
 string $value Referral token.

---

Filters the referral cookie name

Params
 string            $referral_cookie_name Referral cookie name.
 string            $token                Current token.
 YITH_WCAF_Session $this                 This object.

---

Filters the referral cookie expiration (in seconds)

Params
 string            $referral_cookie_exp Referral cookie expiration.
 string            $token                Current token.
 YITH_WCAF_Session $this                 This object.

---

Filters the referral cookie value

Params
 string $cookie_value Referral cookie value.

---

Filters whether the referral cookie has been set

Params
 bool $has_referral_cookie Whether the referral cookie is set or not.

---

Filters whether to set the referral cookie

Params
 bool $set_referral_cookie Whether to set referral cookie or not.

---

includes/class-yith-wcaf-shortcodes-premium.php

Filters the available shortcodes

Params
 array $shortcodes Available shortcodes.

---

includes/class-yith-wcaf-shortcodes.php

Filters the available shortcodes

Params
 array $shortcodes Available shortcodes.

---

includes/class-yith-wcaf-withdraws.php

Filters whether the withdraw request should be processed

Params
 bool $res Whether to process withdraw request or not.

---

Filters whether to show the withdraw popup

Params
 bool $res Whether to show the withdraw popup or not.

---

Filters whether the withdraws are enabled

Params
 bool $withdraw_enabled Whether the withdraws are enabled or not.

---

Filters the minimum amount to be able to request a withdraw

Params
 float $minimum_amount Minimum amount to request a withdraw.

---

Filters the allowed file extensions for the invoice upload

Params
 array $allowed_extensions Array of allowed extensions for the invoice upload.

---

Filters the maximum size for the invoice

Params
 int $max_size Maximum size for the invoice.

---

Filters whether to allow the withdraw amount exceed the maximum available amount to withdraw

Params
 bool $allow_exceed_max_withdraw Whether to allow to withdraw over the max amount or not.

---

includes/class-yith-wcaf.php

Allow to filter posts where fontello stylesheet should be loaded; by default file will be loaded only on pages containing [yith_wcaf_link_generator] shortcode

Params
 bool    $should_include Whether stylesheet should be enqueued.
 WP_Post $post           Global post.
 WP      $wp             Global wp.

---

Filters the array with the data needed for the main plugin script

Params
 array $localize_data Array with data for main script.

---

Filters affiliate referral url

Params
 string $referral_url Affiliate referral url.
 string $ref_name     Name of the parameter used for referral token in url.
 string $token        Affiliate token.
 string $base_url     Url used as a base for referral url generation.

---

includes/dashboard/class-yith-wcaf-dashboard-coupon-table.php

Filters the amount to discount when the affiliate's associated coupon is used.
$type will be replaced with the coupon discount type

Params
 float     $amount Coupon amount.
 WC_Coupon $coupon Coupon object.

---

includes/dashboard/class-yith-wcaf-dashboard-my-account.php

Filters the default endpoint

Params
 string $default_endpoint Default endpoint.

---

Filters the rewrite for a given endpoint

Params
 string $rewrite Endpoint rewrite.
 string $endpoint Endpoint key.

---

Filters the id of the Affiliate Dashboard page

Params
 int $dashboard_page_id Affiliate Dashboard page id.

---

Filters the base url for the Affiliate Dashboard

Params
 string $base_url Base url.

---

Filters whether the current page is the Affiliate Dashboard page

Params
 bool $is_affiliate_dashboard Whether the page is the Affiliate Dashboard or not.

---

Filters whether to add subsections in the Affiliate Dashboard endpoint

Params
 bool $add_subsections Whether to add subsections in the Affiliate Dashboard endpoint or not.

---

includes/dashboard/class-yith-wcaf-dashboard-page.php

Filters the id of the Affiliate Dashboard page

Params
 int $dashboard_page_id Affiliate Dashboard page id.

---

Filters the base url for the Affiliate Dashboard

Params
 string $base_url Base url.

---

Filters whether the current page is the Affiliate Dashboard page

Params
 bool $is_affiliate_dashboard Whether the page is the Affiliate Dashboard or not.

---

includes/dashboard/class-yith-wcaf-dashboard-table.php

Filters the columns of the items table in the dashboard.
$item will be replaced with the item that is being displayed in the table

Params
 array $columns Table columns.

---

Filters the objects to show in the table.
$item will be replaced with the item that is being displayed in the table

Params
 YITH_WCAF_Abstract_Objects_Collection $collection Collection of objects to show in table rows.

---

Filters whether the table contains a specific type of items.
$item will be replaced with the item that is being displayed in the table

Params
 bool                      $contains        Whether the table contains a specific type of items or not.
 string                    $what            Kind of items to check.
 YITH_WCAF_Dashboard_Table $dashboard_table Dashboard table object.

---

Filters the content of the empty cell in the dashboard tables.
$item will be replaced with the item that is being displayed in the table

Params
 string $label Label for the empty cell in the table.

---

includes/data-stores/class-yith-wcaf-affiliate-data-store.php

Filters the default algorithm method to generate affiliate token

Params
 string $algorithm Algorithm to use to generate token.

---

Filters the id of the affiliate created

Params
 int $id Affiliate id.

---

Filters the affiliate token given the user id

Params
 string $token   Affiliate token.
 int    $user_id User id.

---

Filters whether to add the Affiliate role

Params
 bool                $add_role  Whether to add the role or not.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

---

Filters whether to generate affiliate token

Params
 bool                $generate_token Whether to generate affiliate token or not.
 YITH_WCAF_Affiliate $affiliate      Affiliate object.
 string              $algorithm      Algorithm to use to generate token.

---

Filters the default affiliate token

Params
 string              $default_token Default token.
 YITH_WCAF_Affiliate $affiliate     Affiliate object.
 string              $algorithm     Algorithm to use to generate token.

---

Filters the length of the random token to be generated

Params
 int $length Token lenght.

---

includes/data-stores/class-yith-wcaf-click-data-store.php

Filters the id of the click created

Params
 int $id Click id.

---

includes/data-stores/class-yith-wcaf-commission-data-store.php

Filters the id of the commission created

Params
 int $id Commission id.

---

includes/data-stores/class-yith-wcaf-payment-data-store.php

Filters the id of the payment created

Params
 int $id Payment id.

---

includes/data-stores/class-yith-wcaf-rate-rule-data-store.php

Filters the id of the rate rule created

Params
 int $id Rate rule id.

---

includes/emails/class-yith-wcaf-admin-paid-commission-email.php

Filters the commission currency in the commissions table

Params
 string   $currency Commission currency.
 WC_Email $email    Email object.

---

includes/emails/class-yith-wcaf-affiliate-banned-email.php

Filters the 'Terms & Conditions' url in the email

Params
 string   $url   Terms & Conditions url.
 WC_Email $email Email object.

---

Filters the 'Terms & Conditions' label in the email

Params
 string   $label Terms & Conditions label.
 WC_Email $email Email object.

---

includes/emails/class-yith-wcaf-affiliate-disabled-email.php

Filters the 'Terms & Conditions' url in the email

Params
 string   $url   Terms & Conditions url.
 WC_Email $email Email object.

---

Filters the 'Terms & Conditions' label in the email

Params
 string   $label Terms & Conditions label.
 WC_Email $email Email object.

---

Filters the url to the Affiliate Dashboard in the email

Params
 string   $url   Affiliate Dashboard url.
 WC_Email $email Email object.

---

includes/emails/class-yith-wcaf-affiliate-enabled-email.php

Filters the 'Terms & Conditions' url in the email

Params
 string   $url   Terms & Conditions url.
 WC_Email $email Email object.

---

Filters the 'Terms & Conditions' label in the email

Params
 string   $label Terms & Conditions label.
 WC_Email $email Email object.

---

Filters the url to the Affiliate Dashboard in the email

Params
 string   $url   Affiliate Dashboard url.
 WC_Email $email Email object.

---

includes/emails/class-yith-wcaf-new-affiliate-commission-email.php

Filters whether to notify the affiliate when a commission is pending

Params
 bool $notify_user Whether to notify the user or not.

---

Filters the commission currency in the commissions table

Params
 string   $currency Commission currency.
 WC_Email $email    Email object.

---

includes/emails/class-yith-wcaf-new-affiliate-email.php

Filters the 'Terms & Conditions' url in the email

Params
 string   $url   Terms & Conditions url.
 WC_Email $email Email object.

---

Filters the 'Terms & Conditions' label in the email

Params
 string   $label Terms & Conditions label.
 WC_Email $email Email object.

---

Filters the url to the Affiliate Dashboard in the email

Params
 string   $url   Affiliate Dashboard url.
 WC_Email $email Email object.

---

includes/emails/class-yith-wcaf-new-affiliate-payment-email.php

Filters whether to notify the affiliate when a commission is paid

Params
 bool $notify_user Whether to notify the user or not.

---

Filters the commission currency in the commissions table

Params
 string   $currency Commission currency.
 WC_Email $email    Email object.

---

includes/functions-yith-wcaf.php

Filters the promotional methods options

Params
 array $promotional_methods Array of "How to promote" method options.

---

Filters the decimal separator

Params
 string $decimal_separator Decimal separator.

---

Filters the thousands separator

Params
 string $thousands_separator Thousands separator.

---

Filters the rate symbol

Params
 string $rate_symbol Rate symbol.

---

Filters the rate format

Params
 string $rate_format Rate format.

---

includes/gateways/class-yith-wcaf-bacs-gateway.php

Filters the name of the Direct bank/wire transfer gateway

Params
 string $gateway_name Gateway name.

---

Filters the label of the account name field in the Direct bank/wire transfer gateway

Params
 string $label Field label.

---

Filters the label of the IBAN field in the Direct bank/wire transfer gateway

Params
 string $label Field label.

---

Filters the label of the swift code field in the Direct bank/wire transfer gateway

Params
 string $label Field label.

---

includes/gateways/class-yith-wcaf-legacy-gateway-wrapper.php

Filters the path to load the gateway classes

Params
 string $path Gateway class path.

---

includes/gateways/class-yith-wcaf-payouts-gateway.php

Filters whether to skip the payout payment

Params
 bool              $skip_payment Whether to skip the payout payment or not.
 YITH_WCAF_Payment $payment      Payment object.

---

includes/gateways/class-yith-wcaf-paypal-gateway.php

Filters whether to force the use of SSL v4

Params
 bool $force_ssl_v4  Whether to force the use of SSL v4 or not.

---

includes/legacy/class-yith-wcaf-affiliates-legacy.php

Filters whether to add the Affiliate role

Params
 bool                $add_role  Whether to add the role or not.
 YITH_WCAF_Affiliate $affiliate Affiliate object.

---

Filters the default affiliate token

Params
 string $default_token Default token.
 int    $user_id       Used id.

---

includes/rest-api/class-yith-wcaf-rest-install.php

Filters whether to enable the reports

Params
 bool $enable_reports Whether to enable the reports or not.

---

Filters the list of report controllers

Params
 array $controllers List of report controllers.

---

includes/rest-api/reports/class-yith-wcaf-rest-reports-controller.php

Filters the list of allowed reports

Params
 array $reports List of allowed reports.

---

includes/shortcodes/class-yith-wcaf-affiliate-dashboard-shortcode.php

Filters the message shown in the Affiliate Dashboard

Params
 string $message          Message.
 string $greeting_message Greeting message.

---

includes/shortcodes/class-yith-wcaf-current-affiliate-shortcode.php

Filters the message shown when there is no affiliate for the current session

Params
 string $message Message.

---

includes/shortcodes/class-yith-wcaf-link-generator-shortcode.php

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

Filters the title of the socials share section for the referral URL

Params
 $socials_share_title Title to share the referral URL.

---

Filters the title to share the referral URL

Params
 $share_title Title to share the referral URL.

---

includes/shortcodes/class-yith-wcaf-show-clicks-shortcode.php

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

includes/shortcodes/class-yith-wcaf-show-commissions-shortcode.php

Filters the commissions to show in the Affiliate Dashboard

Params
 array $commissions Commissions.

---

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

includes/shortcodes/class-yith-wcaf-show-coupons-shortcode.php

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

includes/shortcodes/class-yith-wcaf-show-if-affiliate-shortcode.php

Filters whether to render the content when using yith_wcaf_show_if_affiliate shortcode

Params
 bool   $render_content Whether to render content or not.
 string $rule           Rule to render content.
 bool   $not            Whether to render content or not

---

Filters the content callback when using yith_wcaf_show_if_affiliate shortcode

Params
 array $shortcode_callbacks Shortcode callbacks.

---

includes/shortcodes/class-yith-wcaf-show-payments-shortcode.php

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

includes/shortcodes/class-yith-wcaf-show-settings-shortcode-premium.php

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

includes/shortcodes/class-yith-wcaf-show-settings-shortcode.php

Filters the array with the attritubes needed for the shortcode template.
$tag will be replaced with the shortcode tag

Params
 array $shortcode_atts Attributes for the shortcode template.

---

Filters whether to show the dashboard links in the Affiliate Dashboard

Params
 bool   $show_dashboard_links Whether to show the dashboard links or not.
 string $section              Affiliate dashboard section.

---

includes/third-party/IPNListener/ipnlistener.php

Filters whether to apply a custom certificate info in the IPN listener

Params
 bool $apply_custom_cainfo Whether to apply a custom certificate info in the IPN listener or not.

---

Filters the path for the custom certificate info in the IPN listener

Params
 string $custom_cainfo_path Custom certificate path.

---

Filters whether to apply a custom header in the IPN listener

Params
 bool $apply_custom_httpheader Whether to apply a custom header in the IPN listener or not.

---

Filters the custom HTTP header in the IPN listener

Params
 array $custom_httpheader Custom HTTP header.

---

includes/traits/trait-yith-wcaf-cacheable.php

Filters the object cache

Params
 WP_Object_Cache $wp_object_cache Object cache.

---

plugin-options/affiliates-options.php

Filters the options available in the Affiliates tab

Params
 array $options Array with options

Return
 array

---

plugin-options/affiliates/clicks-options.php

Filters the options available in the Visits subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/affiliates/list-options.php

Filters the options available in the Affiliates List subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/affiliates/rates-options.php

Filters the options available in the Rates subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/commissions-options.php

Filters the options available in the Commissions tab

Params
 array $options Array with options

Return
 array

---

plugin-options/commissions/list-options.php

Filters the options available in the Commissions List subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/commissions/payments-options.php

Filters the options available in the Commissions Payments subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/dashboard-options.php

Filters the options available in the Dashboard tab

Params
 array $options Array with options

Return
 array

---

plugin-options/settings-options.php

Filters the options available in the General Options tab

Params
 array $options Array with options

Return
 array

---

plugin-options/settings/affiliates-dashboard-options.php

Filters the options available in the Affiliate Dashboard subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/settings/affiliates-registration-options.php

Filters the options available in the Affiliates Registration subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/settings/commissions-payments-options.php

Filters the options available in the Commissions & Payments subtab

Params
 array $options Array with options

Return
 array

---

plugin-options/settings/general-options.php

Filters the options available in the General Options subtab

Params
 array $options Array with options

Return
 array

---

templates/emails/commissions-table.php

Filters whether the commission will be visible in the commissions table

Params
 bool  $is_commission_visible Whether the commission is visible or not.
 array $commission            Commission.

---

Filters the CSS class for the commission row in the commissions table

Params
 string   $css_class  CSS class.
 array    $commission Commission.
 WC_Order $order      Commission order.

---

Filters the content on the product column in the commissions table

Params
 string $column     Column content.
 int    $product_id Product ID.
 string $table_type Table type.

---

Filters the commission currency in the commissions table

Params
 string $currency   Commission currency.
 array  $commission Commission.

---

templates/emails/plain/commissions-table.php

Filters whether the commission will be visible in the commissions table

Params
 bool  $is_commission_visible Whether the commission is visible or not.
 array $commission            Commission.

---

Filters the commission currency in the commissions table

Params
 string $currency   Commission currency.
 array  $commission Commission.

---

templates/shortcodes/dashboard-settings-premium.php

Filters whether the payment email field is required

Params
 bool $is_payment_email_required Whether payment email is required or not.

---

Filters the label for the payment email field

Params
 string $label Label.

---

templates/shortcodes/dashboard-settings.php

Filters whether the payment email field is required

Params
 bool $is_payment_email_required Whether payment email is required or not.

---

Filters the label for the payment email field

Params
 string $label Label.

---

templates/shortcodes/dashboard-summary/withdraw-modal-success.php

Filters the success message in the withdraw modal when requesting the payment

Params
 string $message Message.

---

templates/shortcodes/dashboard-summary/withdraw-modal.php

Filters the currency symbol for the amount to be withdrawn

Params
 string $currency_symbol Currency symbol.

---

Filters the step in the input to choose the amount to withdraw

Params
 double $step Step.

---

Filters the text used to add the invoice example in the withdraw modal

Params
 string $text            Text.
 string $invoice_example URL for the invoice example.

---

Filters the maximum size for the invoice

Params
 int $max_size Maximum size for the invoice.

---

Filters the file type for the invoice to be uploaded

Params
 string $file_type_mime File type (mime) Defaul: application/pdf.

---

Filters the 'Terms and Conditions' label in the withdraw modal

Params
 string $label Label.

---

Filters whether is required to accept the terms and conditions when requesting a withdraw

Params
 bool $is_terms_required Whether is required to accept terms or not.

---

Filters the text of the button to request a withdraw

Params
 string $button_text Button text.

---

templates/shortcodes/dashboard-title.php

Filters the section title in the Affiliate Dashboard

Params
 string $title   Title.
 string $section Section.
 array  $atts    Array with section attributes.

---

templates/shortcodes/form-referrer.php

Filters the message shown in the section to enter the affiliate's code

Params
 string $message Message.

---

Filters whether to show the section to enter the referral token in the checkout

Params
 bool $show_referral_field Whether to show the referral field or not.

---

Filters whether to show the message as a notice

Params
 bool $show_message_as_notice Whether to show the message as a notice or not.

---

templates/shortcodes/link-generator.php

Filters the affiliate's referral link

Params
 string $affiliate_referral_link Affiliate's referral link.

---

Filters the text in the link generator

Params
 string $text Text.

---

templates/shortcodes/link-generator/share.php

Filters the subject of the email to share the referral URL

Params
 string $share_link_title Email subject.

---

Filters the body of the email to share the referral URL

Params
 string $share_link_url Share URL.
 string $share_summary  Share URL.

---

templates/shortcodes/registration-form.php

Filters whether to show the section to login as an affiliate

Params
 bool $show_login_section Whether to show login section or not.

---

Filters whether to show the section to register as an affiliate

Params
 bool $show_register_section Whether to show register section or not.

---

Filters the text displayed in the form to become an affilliate

Params
 string $text Text.

---

Filters the text of the button to become an affiliate

Params
 string $text Text.

---

Filters the text displayed when the user is an affiliate

Params
 string $text Text.

---

Filters the text when the user is pending to be approved as an affiliate

Params
 string $text Text.

---

Filters the message when the user has been rejected as an affiliate

Params
 string $reject_message Reject message.

---

views/affiliates/details-panel.php

Filters the origin URL to build the referral URL

Params
 string $url Origin URL

---

views/meta-boxes/referral-commissions-metabox-premium.php

Filters the order total inside the metabox in the edit order page

Params
 string   $formatted_total Order total formatted.
 float    $order_total     Order total.
 WC_Order $order           Order object.

---

Filters the commissions total inside the metabox in the edit order page

Params
 string   $formatted_total Commissions total formatted.
 double   $total           Commissions total.
 WC_Order $order           Order object.

---

Filters the net revenue form the order inside the commissions metabox in the edit order page

Params
 string   $formatted_total Commissions total formatted.
 double   $net_total       Commissions total.
 WC_Order $order           Order object.

---

views/meta-boxes/referral-commissions-metabox.php

Filters the order total inside the metabox in the edit order page

Params
 string   $formatted_total Order total formatted.
 float    $order_total     Order total.
 WC_Order $order           Order object.

---

Filters the commissions total inside the metabox in the edit order page

Params
 string   $formatted_total Commissions total formatted.
 double   $total           Commissions total.
 WC_Order $order           Order object.

---

Filters the net revenue form the order inside the commissions metabox in the edit order page

Params
 string   $formatted_total Commissions total formatted.
 double   $net_total       Commissions total.
 WC_Order $order           Order object.

---

views/rates/add-modal.php

Filters the maximum rate value

Params
 int $max_rate_value Maximum rate value.

---