• Home
• Give_Donate_Form

PHP Class Give_Donate_Form, Give

This class handles donation forms. Show file Open project: wordimpress/give Class Usage Examples

Public Properties

Property	Type	Description
$ID	integer	The donation ID
$comment_count	integer	The comment count
$comment_status	string	The comment status
$filter	string	Filtered
$guid	string	The post GUID
$menu_order	integer	The menu order
$ping_status	string	The ping status
$pinged	string	Pinged
$post_author	integer	The post author
$post_content	string	The post content
$post_content_filtered	string	The post filtered content
$post_date	string	The post date
$post_date_gmt	string	The post GTM date
$post_excerpt	string	The post excerpt
$post_mime_type	string	The mime type0
$post_modified	string	The post modified date
$post_modified_gmt	string	The post modified GTM date
$post_name	string	The post name
$post_parent	integer	The post parent
$post_password	string	The post password
$post_status	string	The post status
$post_title	string	The post title
$to_ping	string	Ping

Public Methods

Method	Description
__construct ( boolean $_id = false, array $_args = [] ) : void	Class Constructor
__get ( string $key ) : mixed	Magic __get function to dispatch a call to retrieve a private property
create ( array $data = [] ) : mixed	Creates a donation form
decrease_earnings ( integer $amount ) : float | false	Decrease the earnings by the given amount
decrease_sales ( integer $quantity = 1 ) : integer | false	Decrement the sale count by one
get_ID ( ) : integer	Retrieve the ID
get_earnings ( ) : float	Retrieve the total earnings for the form
get_form_classes ( $args ) : string	Get form tag classes.
get_form_wrap_classes ( $args ) : string	Get form wrap Classes.
get_goal ( ) : float	Retrieve the goal
get_minimum_price ( ) : float	Retrieve the minimum price.
get_name ( ) : string	Retrieve the donation form name
get_price ( ) : float	Retrieve the price
get_prices ( ) : array	Retrieve the variable prices
get_sales ( ) : integer	Retrieve the sale count for the donation form
get_type ( ) : string	Retrieve the donation form type, set or multi-level
has_variable_prices ( ) : boolean	Has Variable Prices
increase_earnings ( integer $amount ) : float | false	Increase the earnings by the given amount
increase_sales ( integer $quantity = 1 ) : integer | false	Increment the sale count by one
is_close_donation_form ( ) : boolean	Determine if donation form closed or not
is_custom_price_mode ( ) : boolean	Determine if custom price mode is enabled or disabled
is_free ( integer $price_id = false ) : boolean	Determine if the donation is free or if the given price ID is free
is_multi_type_donation_form ( ) : boolean	Get if form type set or not.
is_single_price_mode ( ) : boolean	Determine if single price mode is enabled or disabled

Private Methods

Method	Description
setup_donation_form ( WP_Post $donation_form ) : boolean	Given the donation form data, let's set the variables
update_meta ( string $meta_key = '', string | array | object $meta_value = '' ) : boolean	Updates a single meta entry for the donation form

Method Details

Property Details