La classe Campagne_Caritative vous permet d'obtenir des informations sur une campagne particulière.
Obtenir une instance de Campagne_Caritative
Il existe deux principales façons d'obtenir un objet Campagne_Caritative :
// Instantiate the object directly.
$campaign = new Charitable_Campaign( 123 );
// Get the object using a function.
$campaign = charitable_get_campaign( 123 );Bien que les deux options fonctionnent, nous recommandons d'utiliser campagne_obtenir_caritative pour la compatibilité future (au cas où nous ajouterions la mise en cache d'objets pour les campagnes ou le filtrage).
Méthodes
get( $meta_name, $single = true )
Obtient une valeur de la table post_meta.
Cela encapsule get_post_meta mais ajoute automatiquement le préfixe _campaign_ au champ meta.
// These two are equivalent:
$end_date = $campaign->get( 'end_date', true );
$end_date = get_post_meta( $campaign->ID, '_campaign_end_date', true );is_endless()
Retourne si une campagne est sans fin (c'est-à-dire qu'elle n'a pas de date de fin).
get_suggested_donations()
Retourne un tableau contenant les options de dons suggérés de la campagne.
Si la campagne n'a pas de dons suggérés, elle retournera un tableau vide.
get_end_date( $date_format = '' )
Retourne la date de fin de la campagne, ou false si la campagne n'a pas de date de fin.
Paramètres$date_format
Si spécifié, définit le format de la date de fin. Si vous ne définissez pas de format de date, le format de date du site sera utilisé.
// Get the end date formatted according to the site's default date format.
$campaign->get_end_date();
// Get the end date formatted like "January 1, 2017"
$campaign->get_end_date( 'j F, Y' );
get_end_time()
Obtient l'horodatage de la date de fin, ou false si la campagne n'a pas de date de fin.
// Get the timestamp for the end date.
$campaign->get_end_time();
