LLMS_Access_Plan::get_initial_price( array $price_args = array(), LLMS_Coupon|int|null $coupon = null, string $format = 'float' )
Get the initial price due on checkout.
Description Description
Automatically accounts for Trials, sales, and coupon discounts.
Parameters Parameters
- $price_args
-
(array) (Optional) Arguments passed to the price getter function to generate the price.
Default value: array()
- $coupon
-
(LLMS_Coupon|int|null) (Optional) Coupon ID, object, or
null
if no coupon is being used.Default value: null
- $format
-
(string) (Optional) Format the price to be returned. Options: html, raw, float (default).
Default value: 'float'
Return Return
(mixed)
Source Source
File: includes/models/model.llms.access.plan.php
// If it's free it's a bit simpler. if ( $this->is_free() ) { $ret = $this->get_free_pricing_text( $format ); } else { $price_key = 'price'; // Setup the price key name based on the presence of a trial or sale. if ( $this->has_trial() ) { $price_key = 'trial_price'; } elseif ( $this->is_on_sale() ) { $price_key = 'sale_price'; } $ret = $this->get_price( $price_key, $price_args, $format, $coupon ); } /** * Filter an access plan's initial price due on checkout. * * @since 3.30.1 * * @param mixed $ret Price due on checkout. * @param array $price_args Arguments passed to the price getter function to generate the price. * @param LLMS_Coupon|int|null $coupon Coupon ID, object, or `null` if no coupon is being used. * @param string $format Format the price to be returned. Options: html, raw, float (default). * @param LLMS_Access_Plan $this Access Plan object. */ return apply_filters( 'llms_access_plan_get_initial_price', $ret, $price_args, $coupon, $format, $this ); }
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
Version | Description |
---|---|
3.40.0 | Simplify logic by using new 4th argument ($coupon) of the get_price() method. |
3.30.1 | Introduced. |