La classe Charitable_User vous permet d'accéder aux informations d'un utilisateur particulier.
Charitable_User est une sous-classe de WP_User.
Obtenir une instance de Charitable_User
Étant donné un ID d'utilisateur, vous pouvez récupérer une instance de Charitable_User de l'une des deux manières suivantes :
$user_id = 123;
// Get instance from cache
$user = charitable_get_user( $user_id );
// Direct instantiation
$user = new Charitable_User( $user_id );L'avantage d'utiliser charitable_get_user est qu'il utilise le cache d'objets pour conserver l'instance de Charitable_User.
Propriétés
Charitable_User a accès aux mêmes propriétés que WP_User :
https://codex.wordpress.org/Class_Reference/WP_User
Méthodes
get_donor_id()
Retourne l'ID du donateur pour cet utilisateur. Si cet utilisateur n'a jamais fait de don, cela retournera false.
get_donor()
Ceci retourne un seul enregistrement de la table wp_charitable_donor pour le donateur.
is_donor()
Ceci retourne si l'utilisateur est un donateur.
is_verified()
is_verified()Ceci retourne si l'utilisateur a vérifié son adresse e-mail.
mark_as_verified( $verified )
Ceci définit si le compte de l'utilisateur est vérifié.
Paramètres$verified
Booléen. Si le compte de l'utilisateur est vérifié.
get_email()
Retourne l'adresse e-mail de l'utilisateur.
get_name()
Retourne le nom complet de l'utilisateur. Notez que si l'utilisateur n'a pas fourni de prénom, seul le nom de famille sera retourné ; et vice versa.
get_first_name()
Retourne le prénom de l'utilisateur.
get_last_name()
Retourne le nom de famille de l'utilisateur.
get_location()
Retourne la localisation de l'utilisateur.
Si disponible, ceci affichera la ville de l'utilisateur, suivie de son pays ; si une ville n'est pas définie, ceci affichera l'état de l'utilisateur, suivi de son pays. Si ni la ville ni l'état ne sont affichés, ceci retournera le pays de l'utilisateur.
Si aucun pays n'est défini, seule la ville ou l'état sera affiché.
get_address( $donation_id = '' )
Retourne l'adresse imprimable de l'utilisateur. Si un ID de don est spécifié, ceci retournera l'adresse utilisée pour le don.
Paramètres$donation_id
Optionnel. S'il est défini, ceci retournera l'adresse pour le don. Sinon, ceci retournera l'adresse stockée dans le profil du donateur.
get_donations( $distinct_donations = false)
Ceci retournera un tableau de tous les dons effectués par l'utilisateur.
Paramètres$distinct_donations
Booléen. Si true, ceci ne montrera que les dons uniques.
count_donations( $distinct_donations = false)
Ceci retourne le nombre de dons effectués par le donateur.
Paramètres$distinct_donations
Booléen. Si true, ceci ne comptera que les dons uniques.
count_campaigns_supported()
Ceci retourne le nombre de campagnes auxquelles l'utilisateur a fait un don.
get_total_donated( $campaign_id = false )
Retourne le montant total donné par l'utilisateur, ou le total donné à une campagne particulière par l'utilisateur.
Paramètres :$campaign_id
Optionnel. S'il est défini, ceci obtiendra seulement le montant total donné par le donateur à la campagne donnée. Par défaut, ceci est défini à false.
get_avatar( $size = 100 )
Retourne le HTML pour afficher l'avatar du donateur. Par défaut, ceci retournera le Gravatar associé à l'adresse e-mail du donateur.
Paramètres$size
Optionnel. Définit la largeur et la hauteur de l'avatar à retourner. Par défaut, l'avatar est retourné avec une largeur et une hauteur de 100px.
get_avatar_src( $size = 100 )
Retourne le fichier source de l'image de l'avatar.
Paramètres$size
Optionnel. Définit la largeur et la hauteur de l'avatar à retourner. Par défaut, l'avatar est retourné avec une largeur et une hauteur de 100px.
get_campaigns( $args = array() )
Retourne un objet WP_Query avec toutes les campagnes créées par le donateur.
Paramètres$args
Optionnel. Arguments supplémentaires à passer à WP_Query.
get_current_campaigns( $args = array() )
Retourne un objet WP_Query avec toutes les campagnes créées par le donateur qui sont actuellement actives.
Paramètres$args
Optionnel. Arguments supplémentaires à passer à WP_Query.
has_current_campaigns()
Retourne si le donateur a des campagnes en cours.
get_activity( $args = array() )
Retourne un objet WP_Query avec tous les dons et campagnes créés par le donateur, classés par date.
Paramètres$args
Optionnel. Arguments supplémentaires à passer à WP_Query.
