Skip to content

Latest commit

 

History

History
599 lines (367 loc) · 20.7 KB

hooks.md

File metadata and controls

599 lines (367 loc) · 20.7 KB
Raw

Hooks

Actions

pronamic_pay_update_payment

Payment updated.

Arguments

Argument Type Description
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/PaymentsDataStoreCPT.php, line 242

pronamic_pay_pre_create_payment

Pre-create payment.

Arguments

Argument Type Description
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/PaymentsDataStoreCPT.php, line 263

pronamic_pay_new_payment

New payment created.

Arguments

Argument Type Description
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/PaymentsDataStoreCPT.php, line 298

pronamic_payment_status_update_{$source}_{$old_status}_to_{$new_status}

Payment status updated for plugin integration source from old to new status.

{$source} {$old_status} {$new_status}

Arguments

Argument Type Description
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.
$can_redirect bool Flag to indicate if redirect is allowed after the payment update.
$previous_status null|string Previous payment status.
$updated_status null|string Updated payment status.

Source: src/Payments/PaymentsDataStoreCPT.php, line 919

pronamic_payment_status_update_{$source}

Payment status updated for plugin integration source.

{$source}

Arguments

Argument Type Description
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.
$can_redirect bool Flag to indicate if redirect is allowed after the payment update.
$previous_status null|string Previous payment status.
$updated_status null|string Updated payment status).

Source: src/Payments/PaymentsDataStoreCPT.php, line 933

pronamic_payment_status_update

Payment status updated.

Arguments

Argument Type Description
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.
$can_redirect bool Flag to indicate if redirect is allowed after the payment update.
$previous_status null|string Previous payment status.
$updated_status null|string Updated payment status.

Source: src/Payments/PaymentsDataStoreCPT.php, line 945

pronamic_pay_privacy_register_exporters

Register privacy exporters.

Arguments

Argument Type Description
$privacy_manager \Pronamic\WordPress\Pay\PrivacyManager Privacy manager.

Source: src/PrivacyManager.php, line 54

pronamic_pay_privacy_register_erasers

Register privacy erasers.

Arguments

Argument Type Description
$privacy_manager \Pronamic\WordPress\Pay\PrivacyManager Privacy manager.

Source: src/PrivacyManager.php, line 77

pronamic_pay_pre_create_subscription

Pre-create subscription.

Arguments

Argument Type Description
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/SubscriptionsDataStoreCPT.php, line 290

pronamic_pay_new_subscription

New subscription created.

Arguments

Argument Type Description
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/SubscriptionsDataStoreCPT.php, line 327

pronamic_subscription_status_update_{$source}_{$old_status}_to_{$new_status}

Subscription status updated for plugin integration source from old to new status.

{$source} {$old_status} {$new_status}

Arguments

Argument Type Description
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.
$can_redirect bool Flag to indicate if redirect is allowed after the subscription update.
$previous_status null|string Previous subscription status.
$updated_status null|string Updated subscription status.

Source: src/Subscriptions/SubscriptionsDataStoreCPT.php, line 761

pronamic_subscription_status_update_{$source}

Subscription status updated for plugin integration source.

{$source}

Arguments

Argument Type Description
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.
$can_redirect bool Flag to indicate if redirect is allowed after the subscription update.
$previous_status null|string Previous subscription status.
$updated_status null|string Updated subscription status.

Source: src/Subscriptions/SubscriptionsDataStoreCPT.php, line 775

pronamic_subscription_status_update

Subscription status updated.

Arguments

Argument Type Description
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.
$can_redirect bool Flag to indicate if redirect is allowed after the subscription update.
$previous_status null|string Previous subscription status.
$updated_status null|string Updated subscription status.

Source: src/Subscriptions/SubscriptionsDataStoreCPT.php, line 787

pronamic_subscription_renewal_notice_{$source}

Send renewal notice for source.

{$source}

Arguments

Argument Type Description
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/SubscriptionsNotificationsController.php, line 247

pronamic_pay_license_check

Perform license check.

Source: src/LicenseManager.php, line 93

Filters

pronamic_payment_redirect_url

Filters the payment return redirect URL.

Arguments

Argument Type Description
$url
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 427

pronamic_payment_source_text_{$source}

Filters the payment source text by plugin integration source.

Arguments

Argument Type Description
$text string Source text.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 477

pronamic_payment_source_text

Filters the payment source text.

Arguments

Argument Type Description
$text string Source text.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 486

pronamic_payment_source_description

Filters the payment source description.

Arguments

Argument Type Description
$description string Source description.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 509

pronamic_payment_source_description_{$source}

Filters the payment source description by plugin integration source.

Arguments

Argument Type Description
$description string Source description.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 518

pronamic_payment_source_url

Filters the payment source URL.

Arguments

Argument Type Description
$url null|string Source URL.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 542

pronamic_payment_source_url_{$source}

Filters the payment source URL by plugin integration source.

Arguments

Argument Type Description
$url null|string Source URL.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 551

pronamic_payment_provider_url

Filters the payment provider URL.

Arguments

Argument Type Description
$url null|string Provider URL.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 573

pronamic_payment_provider_url_{$gateway_id}

Filters the payment provider URL by gateway identifier.

Arguments

Argument Type Description
$url null|string Provider URL.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Payments/Payment.php, line 594

pronamic_pay_google_analytics_ecommerce_item_name

Filters the item name for Google Analytics e-commerce tracking.

Arguments

Argument Type Description
$name string Item name.
$line \Pronamic\WordPress\Pay\Payments\PaymentLine Payment line.

Source: src/GoogleAnalyticsEcommerce.php, line 215

pronamic_pay_google_analytics_ecommerce_item_product_category

Filters the product category for Google Analytics e-commerce tracking.

Arguments

Argument Type Description
$product_category string|null Product category.
$line \Pronamic\WordPress\Pay\Payments\PaymentLine Payment line.

Source: src/GoogleAnalyticsEcommerce.php, line 262

pronamic_pay_return_should_redirect

Filter whether or not to allow redirects on payment return.

Arguments

Argument Type Description
$should_redirect bool Flag to indicate if redirect is allowed on handling payment return.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Plugin.php, line 552

pronamic_pay_gateways

Filters the gateway integrations.

Arguments

Argument Type Description
$gateways \Pronamic\WordPress\Pay\AbstractGatewayIntegration[] Gateway integrations.

Source: src/Plugin.php, line 716

pronamic_pay_plugin_integrations

Filters the plugin integrations.

Arguments

Argument Type Description
$plugin_integrations \Pronamic\WordPress\Pay\AbstractPluginIntegration[] Plugin integrations.

Source: src/Plugin.php, line 731

pronamic_payment_gateway_configuration_id

Filters the payment gateway configuration ID.

Arguments

Argument Type Description
$config_id null|int Gateway configuration ID.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Plugin.php, line 1152

pronamic_payment_redirect_url_{$source}

Filters the payment redirect URL by plugin integration source.

Arguments

Argument Type Description
$url string Redirect URL.
$payment \Pronamic\WordPress\Pay\Payments\Payment Payment.

Source: src/Plugin.php, line 1373

pronamic_pay_modules

Arguments

Argument Type Description
[]

Source: src/Admin/AdminPaymentPostType.php, line 590

pronamic_gateway_configuration_display_value

Filters the gateway configuration display value.

Arguments

Argument Type Description
$display_value string Display value.
$post_id int Gateway configuration post ID.

Source: src/Admin/AdminGatewayPostType.php, line 131

pronamic_gateway_configuration_display_value_{$id}

Filters the gateway configuration display value.

The dynamic portion of the hook name, $id, refers to the gateway ID. For example, the gateway ID for Payvision is payvision, so the filter for that gateway would be: pronamic_gateway_configuration_display_value_payvision

Arguments

Argument Type Description
$display_value string Display value.
$post_id int Gateway configuration post ID.

Source: src/Admin/AdminGatewayPostType.php, line 139

pronamic_pay_modules

Arguments

Argument Type Description
[]

Source: src/Admin/AdminModule.php, line 814

pronamic_pay_removed_extension_notifications

Filters the removed extensions notifications.

Arguments

Argument Type Description
$notifications \Pronamic\WordPress\Pay\Admin\AdminNotification[] Notifications for removed extensions.

Source: src/Admin/AdminNotices.php, line 65

pronamic_pay_modules

Arguments

Argument Type Description
[]

Source: src/Admin/AdminTour.php, line 301

pronamic_subscription_source_text_{$source}

Filters the subscription source text by plugin integration source.

Arguments

Argument Type Description
$text string Source text.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 178

pronamic_subscription_source_text

Filters the subscription source text.

Arguments

Argument Type Description
$text string Source text.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 187

pronamic_subscription_source_description_{$source}

Filters the subscription source description by plugin integration source.

Arguments

Argument Type Description
$description string Source description.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 211

pronamic_subscription_source_description

Filters the subscription source description.

Arguments

Argument Type Description
$description string Source description.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 220

pronamic_subscription_source_url

Filters the subscription source URL.

Arguments

Argument Type Description
$url null|string Source URL.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 243

pronamic_subscription_source_url_{$source}

Filters the subscription source URL by plugin integration source.

Arguments

Argument Type Description
$url null|string Source URL.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 252

pronamic_pay_subscription_next_payment_delivery_date

Filters the subscription next payment delivery date.

Arguments

Argument Type Description
$next_payment_delivery_date \Pronamic\WordPress\DateTime\DateTimeImmutable Next payment delivery date.
$subscription \Pronamic\WordPress\Pay\Subscriptions\Subscription Subscription.

Source: src/Subscriptions/Subscription.php, line 475

pronamic_pay_modules

Arguments

Argument Type Description
[]

Source: src/HomeUrlController.php, line 85

Pronamic WordPress Documentor
Generated by Pronamic WordPress Documentor 1.2.0