AWARE Whistler es una organización benéfica comprometida con la protección del medio ambiente natural de Whistler, Canadá. Este año marca su 30 aniversario como organización y celebra la ocasión lanzando la recaudación de fondos 30 for 30.
El objetivo de la recaudación de fondos "30 for 30" es recaudar 60.000 $, de los cuales 30.000 $ provendrán de empresas y 30.000 $ de donaciones individuales.
AWARE está utilizando el enfoque de recaudación de fondos basado en campañas de Charitable para impulsar esta campaña, con dos campañas de recaudación de fondos individuales configuradas: una para empresas y otra para individuos.
El desafío
Por supuesto, las campañas únicas como esta tienden a tener necesidades únicas, y la recaudación de fondos "30 for 30" no es una excepción.
Dado que una de las dos campañas de recaudación de fondos se centra específicamente en obtener donaciones de empresas, se necesita un campo "Nombre de la empresa" en el formulario de donación de esa campaña. Además, cuando se muestran los donantes en el sitio (usando el shortcode o widget de Donantes), debe mostrarse el nombre de la empresa, no el nombre de la persona que dona.
Afortunadamente, la flexibilidad de Charitable se adapta perfectamente a las necesidades de AWARE. Veamos cómo.
Paso 1. Añadir un campo "Nombre de la empresa"
Lo primero que necesitamos hacer es crear un nuevo campo de donación, utilizando la API de Campos de Donación.
Veamos el código necesario para lograrlo:
/**
* STEP 1: Register the "Company Name" Donation Field.
*
* On the `init` hook, we create a new Donation Field. It has a
* key of `company_name` (this is how we will reference it later),
* and it's set up as a required field in the donation form, shown
* after the `last_name` field.
*/
add_action( 'init', function() {
/**
* Add a "Company Name" field.
*/
$field = new Charitable_Donation_Field(
'company_name',
[
'label' => 'Company Name',
'data_type' => 'user',
'donation_form' => [
'show_after' => 'last_name',
'required' => true,
],
'admin_form' => true,
'show_in_meta' => true,
'show_in_export' => true,
'email_tag' => [
'description' => 'The company name',
],
]
);
/**
* Register the field.
*/
charitable()->donation_fields()->register_field( $field );
}, 100 );
Aquí hay un poco de código. En primer lugar, justo en la parte superior, estamos configurando una función para que se ejecute en el hook init. Este es el mejor hook para usar cada vez que desee registrar un nuevo campo de donación.
Dentro de nuestra función, creamos un nuevo Campo de Donación con el objeto Charitable_Donation_Field. Echemos un vistazo más de cerca a esa parte:
$field = new Charitable_Donation_Field(
'company_name',
[
'label' => 'Company Name',
'data_type' => 'user',
'donation_form' => [
'show_after' => 'last_name',
'required' => true,
],
'admin_form' => true,
'show_in_meta' => true,
'show_in_export' => true,
'email_tag' => [
'description' => 'The company name',
],
]
);
Lo que estamos haciendo aquí es crear un campo con una clave company_name (la necesitaremos más adelante). Hemos establecido una etiqueta, la hemos definido como un campo de usuario y hemos establecido algunas reglas básicas sobre cómo debe aparecer en el formulario de donación: justo después del campo last_name y como campo obligatorio.
También lo hemos configurado para que se muestre en el formulario de donación del administrador, en los metadatos de la donación y en el archivo de exportación de donaciones. Incluso le hemos dicho a Charitable que cree una etiqueta de correo electrónico para él, para que podamos usarla en nuestros correos electrónicos de recibo de donaciones.
Finalmente, registramos este campo con la API de Campos de Donación:
charitable()->donation_fields()->register_field( $field );
Paso 2. Mostrar el campo "Nombre de la empresa" solo en una campaña
Por defecto, cuando configuras un campo de donación, aparecerá en el formulario de donación de todas las campañas. Sin embargo, para la campaña "30 for 30", AWARE solo quiere que el campo aparezca en el formulario de donación de la recaudación de fondos para empresas.
Así es como lo logramos:
/**
* STEP 2: Only show the field on a specific campaign.
*
* We only want the field to show up on a single campaign's
* form, so we *remove* it from all other campaigns' donation
* forms.
*/
add_filter( 'charitable_donation_form_user_fields', function( $fields, Charitable_Donation_Form $form ) {
/**
* Check the campaign ID of the donation form being
* shown. If it isn't the one where we want the field,
* remove the field using the unset() function.
*/
if ( 123 != $form->get_campaign()->ID ) {
unset( $fields['company_name'] );
}
return $fields;
}, 10, 2 );
La forma en que resolvemos este problema es eliminando el campo company_name cuando no estamos mostrando el formulario de donación de la campaña empresarial. Toda la magia ocurre aquí:
if ( 123 != $form->get_campaign()->ID ) {
unset( $fields['company_name'] );
}
En este caso, imaginamos que la campaña de Negocios tiene un ID de 123. Así que, cuando miramos los campos de un formulario en particular, comprobamos el ID de la campaña del formulario y, si no es 123, usamos la función unset() para deshacernos de nuestro campo, refiriéndonos a él por la clave de company_name, que establecimos en el Paso 1.
Paso 3. Personaliza el nombre del donante en el shortcode o widget de Donantes
Ahora que hemos añadido nuestro campo de Nombre de Empresa, todo lo que queda es usar eso en lugar del nombre y apellido del donante al mostrar donaciones a la campaña de Negocios.
Veamos el código:
/**
* STEP 3: Use the company name for the donor name.
*
* When showing the donor name for a particular donation,
* check if the donation was to the campaign with our
* Company Name field. If it was, show the Company Name
* instead of the individual's name.
*/
add_filter( 'charitable_donor_loop_donor_name', function( $name, $args ) {
/**
* Get the Donor object from the argument array.
*/
$donor = $args['donor'];
/**
* Check if there is a Donation object associated
* with this Donor.
*/
$donation = $donor->get_donation();
if ( ! $donation ) {
return $name;
}
/**
* Get the campaign that received the donation.
*/
$campaign_id = current( $donation->get_campaign_donations() )->campaign_id;
/**
* If this was a donation to our campaign,
* let's change the donor name.
*/
if ( 123 == $campaign_id ) {
$name = $donation->get( 'company_name' );
}
return $name;
}, 15, 2 );
En primer lugar, observa que esto está configurado como una función llamada en el hook charitable_donor_loop_donor_name. Usamos este hook ya que se muestra siempre que se muestra una lista de donantes con el widget de Donantes o el shortcode.
Dentro de la función, primero obtenemos el objeto Charitable_Donor del parámetro $args. Luego obtenemos el objeto Charitable_Donation a través del método $donor->get_donation():
/**
* Check if there is a Donation object associated
* with this Donor.
*/
$donation = $donor->get_donation();
if ( ! $donation ) {
return $name;
}
Puede que te preguntes por qué comprobamos si $donation está establecido. La razón es que a veces, Charitable_Donor no está configurado con una donación específica. Un ejemplo es cuando el widget/shortcode de Donantes está configurado para agrupar múltiples donaciones del mismo donante en una; en ese caso, no se llama a ningún objeto Charitable_Donation, y simplemente mostraremos el nombre del donante.
Por lo tanto, una advertencia importante de este enfoque es que solo funcionará si el widget/shortcode de Donantes está configurado para mostrar cada donación individualmente, en lugar de agrupar múltiples donaciones de la misma persona.
A continuación, usamos el objeto Charitable_Donation para averiguar a qué campaña se donó y comprobamos si es nuestra campaña de Negocios (la que tiene un ID de 123):
/**
* Get the campaign that received the donation.
*/
$campaign_id = current( $donation->get_campaign_donations() )->campaign_id;
/**
* If this was a donation to our campaign,
* let's change the donor name.
*/
if ( 123 == $campaign_id ) {
$name = $donation->get( 'company_name' );
}
La última parte de esto simplemente comprueba que $campaign_id es 123. Si lo es, obtenemos el nombre de la empresa de la siguiente manera:
$donation->get( 'company_name' );
Ten en cuenta que company_name coincide con la clave del campo de donación que registramos en el paso 1.
¡Y con eso, hemos terminado!
La solución completa
Puedes ver todo el código reunido en un solo lugar en nuestra biblioteca de código de Github:
Para verlo en acción – y si te gustaría mostrar tu apoyo al importante trabajo realizado por AWARE Whistler – visita la página 30 for 30 Fundraiser en su sitio web.
Palabra final
Si disfrutaste de este tutorial y te gustaría que escribiéramos uno sobre un tema diferente, ¡háznoslo saber! Puedes contactarnos por correo electrónico rellenando el formulario en nuestra página de Soporte, o dejando un comentario abajo.
Deja una respuesta