Documentation Category: Classes

The Charitable_Donation_Field class allows you to create new donation fields or edit existing ones. Table of Contents Usage Create a new donation field Get an existing donation field Properties Methods __construct set __set __get Usage Create a new donation field If you want to add a new donation field, you will first need to create…

The Charitable_User class allows you to get access to information about a particular user. Charitable_User is a sub-class of WP_User. Getting an instance of Charitable_User Given a user ID, you can retrieve a Charitable_User instance in one of two ways: The advantage of using charitable_get_user is that it uses the object cache to retain the…

The Charitable_Donor class allows you to get access to information about a particular donor. Getting an instance of Charitable_Donor A Charitable_Donor instance can be retrieved in different ways depending on the context in which you need to use it. With a donor ID With a donor ID and a donation ID With a donation object…

The Charitable_Campaign class allows you to get information about a particular campaign. Getting an instance of Charitable_Campaign There are two primary ways to get a Charitable_Campaign object: While both options work, we recommend using charitable_get_campaign for forward-compatibility (in case we add object caching for campaigns or filtering). Class source code Methods get( $meta_name, $single = true ) Get a…

The Email Fields API was introduced in version 1.5 and provides a cleaner way to add new email tags or modify existing ones. Defining a Field An email field is defined as an array with a few arguments, and a key which is used for the show parameter in the [charitable_email] shortcode. Arguments description: The description that…