plugin-options/user-views-options.php
Filter the available options from the User views section
Params
array $setting The options to display.
plugin-options/price-rules-options.php
Filter the available options from the Price rules section
Params
array $setting The options to display.
plugin-options/general-settings-options.php
Filter the available options from the General settings section
Params
array $setting The options to display.
includes/class.yith-role-based-prices.php
Filters the capability to access the plugin settings
Params
string $capability The needed capability.
includes/class.yith-role-based-prices-product.php
Check if it should return the original price of the product
Paramsbool $return If it should return the original price.
float $price The current price.
WC_Product $product The current product.
Filters the rule price for a product
Paramsfloat $rule_price The rule price.
WC_Product $product The current product.
The rule price for the view context
Paramsfloat $role_based_price The rule price.
WC_Product $product The current product.
Check if it should return the original price of the product
Paramsbool $return If it should return the original price.
float $price The current price.
WC_Product $product The current product.
Filters the price HTML for the current price
Paramsstring $price The current price HTML.
WC_Product $product The current product.
Filters the price suffix for the product
Paramsstring $price_display_suffix The current price suffix.
YITH_Role_Based_Prices_Product $this The YITH_Role_Based_Prices_Product instance.
Check if it should display the regular price
Paramsbool $show_regular_price Show regular price.
string $regular_price The regular price.
array $rule_price The rule-based price and matched rules.
WC_Product $product The current product.
Filters the simple regular price HTML for the current product
Paramsstring $regular_price_html The regular price HTML.
string $regular_price The regular price.
WC_Product $product The current product.
bool $show_del Show the del element.
Filters the simple sale price HTML for the current product
Paramsstring $sale_price_html The sale price HTML.
string $sale_price The sale price.
WC_Product $product The current product.
bool $show_del Show the del element.
Filters the simple rule-based price HTML for the current product
Paramsstring $rule_price_html The rule-based price HTML.
float $rule_price The rule-based price.
WC_Product $product The current product.
bool $show_del Show the del element.
Returnstring
Filters the current min sale price for the product
Paramsfloat $min_sale_price The min sale price.
float $min_sale_price The min sale price.
WC_Product $product The current product.
Filters the current max sale price for the product
Paramsfloat $max_sale_price The max sale price.
float $max_sale_price The max sale price.
WC_Product $product The current product.
Check if it should display the regular price of the variable product
Paramsbool $show_regular_price Show regular price.
WC_Product $product The current product.
bool $has_rule_price If the current product has matching rules.
Filters the regular price HTML for the variable product
Paramsstring $regular_price_html The regular price HTML.
WC_Product $product The current product.
float $min_regular_price The min regular price.
float $max_regular_price The max regular price.
Filters the sale price HTML for the variable product
Paramsstring $sale_price_html The sale price HTML.
WC_Product $product The current product.
float $min_sale_price The min sale price.
float $max_sale_price The max sale price.
Filters the sale price HTML for the variable product
Paramsstring $sale_price_html The sale price HTML.
WC_Product $product The current product.
float $min_sale_price The min sale price.
float $max_sale_price The max sale price.
Filters the regular price HTML for the grouped product
Paramsstring $regular_price_html The sale price HTML.
WC_Product $product The current product.
float $min_original_price The min original price.
float $max_original_price The max original price.
Filters the price HTML for the variable product
Paramsstring $price_html The price HTML.
array $rule_price The current rule price and the matched rules.
WC_Product $product The current product.
Filters the regular price HTML for the product
Paramsstring $regular_html The regular price HTML.
WC_Product $product The current product.
Filters the regular price HTML for the product
Paramsstring $sale_price_html The sale price HTML.
WC_Product $product The current product.
Filters the template args for the 'Your price' HTML
Paramsarray $template_args The current template args.
string $your_price_html The 'Your price' HTML.
float $role_price The rule price.
float $display_role_price The display rule price.
WC_Product $product The current product.
bool $display_price Display price.
string $message The message to include.
Filters the 'Your price' HTML
Paramsstring $price_html The display rule price.
WC_Product $product The current product.
Filters the 'Your price' HTML
Paramsstring $price_html The display rule price.
WC_Product $product The current product.
Filters the rule price HTML for other roles
Paramsstring $their_price_html The rule prices HTML.
WC_Product $product The current product.
Filters the rule price HTML for other roles
Paramsstring $their_price_html The rule prices HTML.
WC_Product $product The current product.
string $min Min variation rule price.
string $max Max variation rule price.
Check if it should show the discount total for the other role prices
Paramsbool $show_discount_total Show discount total.
WC_Product $product The current product.
Check if it should show the discount total for the other role prices
Paramsbool $show_discount_total Show discount total.
WC_Product $product The current product.
Filters an array with the rule-based prices and the rules matched by the variations
Paramsarray $rule_price The rule-based prices and the rules matched by the variations.
array $variation_prices The prices of the variations.
WC_Product $product The current product.
Filters an array with the rule-based prices and the rules matched by the grouped product items
Paramsarray $rule_price The rule-based prices and the rules matched by the grouped product items.
array $item_prices The prices of the items.
WC_Product $product The current product.
Filters the total markup or discount formatted HTML for a product
Paramsstring $discount_html The formatted discount HTML.
string $discount The discount type.
WC_Product $product The current product.
Filters the context to be used for the product prices
Params
string $context The context to be used.
Check if the variation price should use the newer methods
Params
bool $use_method Use newer price method.
Filters the 'Your price' label for the price HTML.
Params
string $your_price_txt The 'Your price' label.
Filters the 'free' price HTML.
Params
string $free_price_text The 'free' price HTML.
Filters the 'Your price' label for the price HTML.
Params
string $your_price_txt The 'Your price' label.
Filters the 'free' price HTML.
Params
string $free_price_text The 'free' price HTML.
Filters the 'free' price HTML.
Params
string $price_html The 'free' price HTML.
Filters the 'free' price HTML.
Params
string $price_html The 'free' price HTML.
Filters the CSS class for the custom message
Params
string $class_message The CSS class.
Filters the custom message to be printed
Params
string $custom_message The custom message.
includes/class.yith-role-based-prices-post-type.php
DEPRECATED - Filters the query args to get the price rules
Paramsarray $args The query args.
int $product_id The current product ID.
Filters the role that should have rules capabilities
Params
string $role The role to be used.
Filters the labels for the price rule taxonomy
Params
array $labels The labels for the taxonomy.
includes/class.yith-role-based-prices-admin.php
Filters the message for the delete transient action
Params
string $message The message to be displayed.
includes/class-yith-wcrbp-price-rule.php
Filters the IDs of the product that should be checked in the price rule
Paramsarray $product_ids The product IDs.
int|WC_Product $product The product to check for.
Filters the IDs of the product that should be checked in the price rule
Paramsarray $product_ids The product IDs.
int|WC_Product $product The product to check for.
includes/class-yith-wcrbp-price-rule-helper.php
Filters the query args to be used to get the products
Paramsarray $args The arguments for the query.
false|WC_Product $product The current product to get the rules for.
Filters the query args to be used to get the products
Paramsarray $args The arguments for the query.
false|WC_Product $product The current product to get the rules for.
Filters the price for the product to use for the price calculation
Paramsfloat $product_price The current product price.
WC_Product $product The product to calculate for.
string $use_price Force the specific price of the product: `regular`, `sale`, or `custom`.
float $custom_price The custom price to use for the price calculation (only if `$use_price` equals to `custom`).
Filters whether the price calculation should only apply the user rules or not
Paramsbool $product_price The current product price.
WC_Product $product The product to calculate for.
Filters the correct product to use for the price calculation
Params
WC_Product $product The current product.
Check if the prices need to be rounded
Params
bool $price_rounding Apply rounding?
Returnbool.
Set the PHP rounding to be used
Params
int $type The PHP rounding const
Returnint.
includes/data-stores/class-yith-wcrbp-price-rule-data-store.php
Filters the query vars that will be used to recover the price rules
Paramsarray $wp_query_args The processed query vars.
array $query_vars The initial query vars.
YITH_WCRBP_Price_Rule_Data_Store $object The instance of the data store.