Como todas las extensiones de Charitable, Charitable Stripe está diseñada para ser fácil de usar para los desarrolladores e incluye ganchos y filtros que te ayudarán a realizar las personalizaciones que necesites.
Extensión de pago
Charitable Stripe es un plugin premium. Consíguelo hoy mismo con uno de nuestros paquetes de plugins.
Filtros
descriptor_declaracion_caritativa_stripe
Añadido en la versión 1.3.0
Filtra el descriptor de declaración formateado automáticamente que se envía a Stripe.
Nota: Este filtro solo se utiliza cuando la configuración Formato del descriptor de declaración (en Caritativo > Ajustes > Pasarelas de pago > Stripe) está establecida en “Usar título de campaña”.
Valor de retorno
Cadena. Por defecto, esto devuelve los primeros 22 caracteres del título de la campaña.
Argumentos
$descriptor (cadena)El descriptor predeterminado.
$donación (Charitable_Donation)El objeto de donación.
$procesador (Charitable_Donation_Processor)El objeto procesador de donaciones.
Uso
add_filter(
'charitable_stripe_statement_descriptor',
function( $descriptor, Charitable_Donation $donation ) {
return 'My Custom Statement Descriptor';
},
10,
2
);
campos_metadatos_caritativos_stripe
Añadido en la versión 1.4.0
Filtra la lista de Campos de Donación que se enviarán a Stripe como metadatos para una donación puntual o recurrente determinada.
Valor de retorno
Una matriz de claves para Campos de Donación.
Argumentos
$campos (matriz)Las claves de todos los Campos de Donación cuyos valores se enviarán a Stripe. Por defecto, esto incluirá cualquier campo que se muestre en el formulario de donación del front-end, así como
donation_idydonor.
Uso
/**
* Add a new field to the metadata.
*/
add_filter(
'charitable_stripe_metadata_fields',
function( $fields ) {
// Add the name(s) of the campaign(s) receiving the donation to the metadata
$fields[] = 'campaign_categories_list';
return $fields;
}
);
/**
* Remove a field from the metadata.
*/
add_filter(
'charitable_stripe_metadata_fields',
function( $fields ) {
unset( $fields['address'] );
return $fields;
}
);
metadatos_cargo_caritativo_stripe
Añadido en la versión 1.3.0
Filtra los metadatos pasados a un Intent de Pago, Sesión de Checkout o Cargo.
Valor de retorno
Una matriz de metadatos como pares clave=>valor.
Argumentos
$metadatos (matriz)El conjunto de metadatos.
$donación (Charitable_Donation)El objeto de donación.
$procesador (Charitable_Donation_Processor)El objeto procesador.
eventos_webhook_caritativos_stripe
Añadido en la versión 1.3.0
Filtra la lista de eventos de webhook a los que Charitable está suscrito para recibir notificaciones de Stripe.
Valor de retorno
Una matriz de tipos de eventos de webhook válidos.
Argumentos
$eventos (matriz)Los eventos sobre los que se notificará al webhook.
$aplicacion_connect (booleano)Si este es un webhook para una aplicación Connect.
configurar_webhooks_caritativos_stripe
Añadido en la versión 1.3.0
Filtra si se deben configurar webhooks para este sitio.
Por defecto, esto devolverá true a menos que se trate de localhost.
Valor de retorno
Booleano.
Argumentos
$configurar_webhooks (booleano)Si se deben configurar los webhooks.
Uso
add_filter( 'charitable_stripe_setup_webhooks', '__return_false' );
procesadores_eventos_predeterminados_caritativos_stripe
Añadido en la versión 1.3.0
Modifica los procesadores de eventos predeterminados para tipos de eventos de webhook específicos.
Valor de retorno
Una matriz clave=>valor de tipos de eventos de Stripe y funciones de devolución de llamada asociadas.
Argumentos
$procesadores (matriz)Matriz de tipos de eventos de Stripe y funciones de devolución de llamada asociadas.
directorio_idiomas_caritativos_stripe
Añadido en la versión 1.0.0
Modifica el directorio donde se almacenan las traducciones de extensiones.
Valor de retorno
Una cadena que representa la ruta al directorio de idiomas, relativa al directorio wp-content/plugins.
Argumentos
$directorio (cadena)La ruta del directorio de idiomas. Por defecto es
charitable-stripe/languages.
nombre_gateway_stripe_caritativo
Añadido en la versión 1.0.0
Filtra el nombre de la pasarela tal como se muestra en el área de administración.
Valor de retorno
Cadena. Por defecto es “Stripe”.
Argumentos
$nombre (cadena)Nombre de la pasarela.
ruta_plantilla_tema_caritativa_stripe
Añadido en la versión 1.4.0
Filtra la plantilla de tema de Stripe.
Valor de retorno
Una cadena que representa el directorio donde se almacenan las plantillas de tema, relativa a la carpeta del tema.
Argumentos
$ruta_plantilla (cadena)La ruta de la plantilla. Por defecto es
charitable/charitable-stripe.
checkout_procesador_gateway_stripe_caritativo
Añadido en la versión 1.4.0
Filtra la clase procesadora utilizada para gestionar las donaciones de Checkout.
Valor de retorno
Una cadena que representa el nombre de una clase que desciende de la clase base Charitable_Stripe_Gateway_Processor. Por defecto es Charitable_Stripe_Gateway_Processor_Checkout.
Argumentos
$clase (cadena)El nombre de la clase procesadora de pasarelas de Stripe.
$procesador (Charitable_Donation_Processor)El ayudante del procesador de donaciones.
payment_intents_procesador_gateway_stripe_caritativo
Añadido en la versión 1.4.0
Filtra el procesador utilizado para gestionar las donaciones de PaymentIntent.
Valor de retorno
Una cadena que representa el nombre de una clase que desciende de la clase base Charitable_Stripe_Gateway_Processor. Por defecto es Charitable_Stripe_Gateway_Processor_Payment_Intents.
Argumentos
$clase (cadena)El nombre de la clase procesadora de pasarelas de Stripe.
$procesador (Charitable_Donation_Processor )El ayudante del procesador de donaciones.
argumentos_cliente_stripe_caritativo
Añadido en la versión 1.2.2
Filtra los argumentos del cliente de Stripe.
Valor de retorno
Una matriz de argumentos que se pasarán a una llamada \Stripe\Customer::create()
Argumentos
$argumentos (matriz)Los argumentos del cliente.
$donante (Charitable_Donor)El objeto Donor.
argumentos_sesion_stripe_caritativo
Añadido en la versión 1.4.0
Filtra los argumentos de la Sesión.
Valor de retorno
Una matriz de argumentos que se utilizarán en una llamada a \Stripe\Checkout\Session::create()
Argumentos
$argumentos (matriz)Los argumentos de la Sesión.
$donación (Charitable_Donation)El objeto de donación.
$procesador (Charitable_Donation_Processor)El objeto procesador.
$gateway (Charitable_Gateway_Stripe)El ayudante de la clase Stripe gateway.
Uso
/**
* Change the 'submit_type' argument to 'pay' instead of 'donate'.
*/
add_filter(
'charitable_stripe_session_args',
function( $args ) {
if ( array_key_exists( 'submit_type', $args ) ) {
$args['submit_type'] = 'pay';
}
return $args;
}
);
argumentos_payment_intent_stripe_caritativo
Añadido en la versión 1.4.0
Filtra los argumentos del PaymentIntent.
Valor de retorno
Una matriz de argumentos que se utilizarán en una \Stripe\PaymentIntent::create()
Argumentos
$argumentos (matriz)Los argumentos del PaymentIntent.
$donación (Charitable_Donation)El objeto de donación.
$procesador (Charitable_Donation_Processor)El objeto procesador.
$gateway (Charitable_Gateway_Stripe)El ayudante de la clase Stripe gateway.
Uso
/**
* Change the 'description' argument.
*/
add_filter(
'charitable_stripe_payment_intent_args',
function( $args, $donation ) {
$args['description'] = 'My payment description';
return $args;
},
10,
2
);
argumentos_suscripciones_stripe_caritativo
Añadido en la versión 1.4.0
Filtra los argumentos pasados a Stripe para crear una nueva Suscripción.
Valor de retorno
Una matriz de argumentos que se pasan a una llamada a \Stripe\Subscription::create().
Argumentos
$argumentos (matriz)Los argumentos de la suscripción.
$recurring (Charitable_Recurring_Donation)El objeto de donación recurrente.
$processor (Charitable_Stripe_Gateway_Processor)Esta instancia del procesador de pasarela.
argumentos_plan_stripe_caritativo
Añadido en la versión 1.4.3
Filtra los argumentos pasados a Stripe para crear un nuevo plan.
Valor de retorno
Una matriz de argumentos que se pasan a una llamada a \Stripe\Plan::create().
Argumentos
$plan_args (matriz)Los argumentos del plan a enviar a Stripe.
$plan (Charitable_Stripe_Plan)Una instancia del objeto Charitable_Stripe_Plan.
argumentos_producto_stripe_caritativo
Añadido en la versión 1.4.3
Filtra los argumentos pasados a Stripe para crear un nuevo producto.
Valor de retorno
Una matriz de argumentos que se pasan a una llamada a \Stripe\Product::create().
Argumentos
$product_args (matriz)Los argumentos del producto a enviar a Stripe.
$product (Charitable_Stripe_Product)Una instancia de
Charitable_Stripe_Product.
descriptor_declaracion_producto_stripe_caritativo
Añadido en la versión 1.4.0
Filtra el statement_descriptor formateado automáticamente para los productos.
Valor de retorno
Una cadena que se utilizará como descriptor de declaración para un nuevo objeto de Producto de Stripe.
Argumentos
$descriptor (cadena)El descriptor predeterminado.
$product (Charitable_Stripe_Product)La instancia
Charitable_Stripe_Product.
estado_suscripcion_recurrente_stripe_caritativo
Añadido en la versión 1.2.0
Filtra el estado de una suscripción recurrente basándose en un estado de Stripe.
Valor de retorno
Cadena. Un estado de donación recurrente válido de Charitable (uno de charitable-pending, charitable-active, charitable-onhold, charitable-cancelled, charitable-expired, charitable-failed, charitable-cancel).
Argumentos
$status (cadena)El estado de Charitable.
$stripe_status (cadena)El estado de Stripe para la suscripción. Consulta la lista de estados posibles de Stripe.
cargar_scripts_stripe_en_todo_el_sitio_caritativo
Añadido en la versión 1.4.3
Si se debe cargar el script de Stripe en todo el sitio.
Valor de retorno
Booleano. Devuelve verdadero para cargar los scripts en todo el sitio (por defecto), o falso para cargar solo los scripts de Stripe en el formulario de donación.
Argumentos
$load (booleano)Si se deben cargar los scripts en todo el sitio. Por defecto es verdadero.
Uso
add_filter( 'charitable_stripe_load_stripe_scripts_sitewide', '__return_false' );
Ganchos de acción
evento_ipn_stripe_caritativo
Añadido en la versión 1.0.0
Dispara un hook de acción para procesar el evento.
Ten en cuenta que esto solo se activará para webhooks que aún no hayan sido procesados por uno de los manejadores de webhooks predeterminados.
Valor de retorno
Vacío
Argumentos
$event_type (cadena)Tipo de evento.
$event (\Stripe\Event)Objeto de evento de Stripe.
