Coupon Creator Add-Ons Hooks Reference

`artifex_license_store_url` #

apply_filters( 'artifex_license_store_url', string $url, string $slug )

Filters the EDD licensing endpoint.

$url (string) — Store URL.
$slug (string) — Plugin slug.

Source: src/Cctor/Admin/SDK_License.php

`cctor_addons_can_run` #

apply_filters( 'cctor_addons_can_run', bool $plugin_can_run )

Filter whether the plugin can run.

$plugin_can_run (bool) — Whether the plugin can run.

Since 3.0 · Source: coupon-creator-add-ons.php

`cctor_addons_cookie_expiration` #

apply_filters( 'cctor_addons_cookie_expiration', int|string $expiration, int $coupon_id )

Filters the dynamic-code cookie expiration timestamp.

$expiration (int|string) — Unix timestamp when the cookie expires. Defaults to 30 days from now when the coupon ignores expiration or has no usable expiration date.
$coupon_id (int) — The coupon post ID.

Since 3.5.2 · Source: src/Cctor/Cookie.php

`cctor_addons_dynamic_csv_max_bytes` #

apply_filters( 'cctor_addons_dynamic_csv_max_bytes', int $max_bytes, int $csv_file_id )

Filters the maximum dynamic-code csv file size in bytes.

The default of 1MB is roughly 100k single-column codes. Zero or a negative value disables the cap.

$max_bytes (int) — Maximum file size in bytes.
$csv_file_id (int) — The csv attachment id.

Since 3.5.2 · Source: src/Cctor/Dynamic.php

`cctor_addons_email_delivery_enabled` #

apply_filters( 'cctor_addons_email_delivery_enabled', bool $activate )

Allows filtering whether the Email Delivery Provider should be activated or not.

Note: this filter will only apply if the disable constant or env var are not set or are set to falsy values.

$activate (bool) — Defaults to <code>true</code>.

Since 3.5.0 · Source: src/Cctor/Email/Provider.php

`cctor_addons_email_gate_enabled` #

apply_filters( 'cctor_addons_email_gate_enabled', bool $activate )

Allows filtering whether the Email Gate Provider should be activated or not.

$activate (bool) — Defaults to <code>true</code>.

Since 3.5.0 · Source: src/Cctor/Email_Gate/Provider.php

`cctor_addons_multi_print_add_cart_item` #

apply_filters( 'cctor_addons_multi_print_add_cart_item', (string|mixed)[] $cart_contents )

Filter an item to multiPrint cart contents after item data merge.

$cart_contents ((string|mixed)[]) — An array of cart contents.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_cart_add_cart_item_data` #

apply_filters( 'cctor_addons_multi_print_cart_add_cart_item_data', (string|mixed)[] $cart_item_data, int $coupon_id, int $quantity )

Filter an item data.

$cart_item_data ((string|mixed)[]) — An array of item data.
$coupon_id (int) — <ul>
<li>id of the coupon the key is being generated for.</li>
</ul>
$quantity (int) — contains the quantity of the item.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_cart_contents_changed` #

apply_filters( 'cctor_addons_multi_print_cart_contents_changed', (string|mixed)[] $cart_contents )

Filter before multiPrint cart contents set from session on a change.

$cart_contents ((string|mixed)[]) — An array of cart contents.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_cart_database_install_capabilities_check` #

apply_filters( 'cctor_addons_multi_print_cart_database_install_capabilities_check', string $ajax_capability )

Allows filtering of the capability required to use reinstall the database.

$ajax_capability (string) — The capability required to use the ajax features, default manage_options.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Database/Controller.php

`cctor_addons_multi_print_cart_hash` #

apply_filters( 'cctor_addons_multi_print_cart_hash', string $hash, (string|mixed)[] $cart_session )

Filter when getting the multiPrint cart contents.

$hash (string) — Hash for multiPrint cart content.
$cart_session ((string|mixed)[]) — An array of cart contents.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_cart_id` #

apply_filters( 'cctor_addons_multi_print_cart_id', (string|mixed)[] $id_parts, int $coupon_id, array $cart_item_data )

Filter the unique id generated for a cart item.

$id_parts ((string|mixed)[]) — An array of identifiers to create a unique string from.
$coupon_id (int) — <ul>
<li>id of the coupon the key is being generated for.</li>
</ul>
$cart_item_data (array) — other cart item data passed which affects this items uniqueness in the cart.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_cart_session_handler` #

apply_filters( 'cctor_addons_multi_print_cart_session_handler', string $session_class )

Allows filtering the class to clean up the multiPrint cart session table.

$session_class (string) — The cart session handler class name. Default Cart_Session::class.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Multi_Print_Provider.php

`cctor_addons_multi_print_cart_total` #

apply_filters( 'cctor_addons_multi_print_cart_total', mixed $ )

Filter the cart display total coupons value.

$ (mixed) — The cart display total coupons value.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_enabled` #

apply_filters( 'cctor_addons_multi_print_enabled', bool $activate )

Allows filtering whether the MultiPrint Provider should be activated or not.

Note: this filter will only apply if the disable constant or env var are not set or are set to falsy values.

$activate (bool) — Defaults to <code>true</code>.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Multi_Print_Provider.php

`cctor_addons_multi_print_get_cart_contents` #

apply_filters( 'cctor_addons_multi_print_get_cart_contents', (string|mixed)[] $cart_contents )

Filter when getting the multiPrint cart contents.

$cart_contents ((string|mixed)[]) — An array of cart contents.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_get_cart_item_from_session` #

apply_filters( 'cctor_addons_multi_print_get_cart_item_from_session', (string|mixed)[] $session_data, (string|mixed)[] $item, string $key )

Filter the multiPrint coupon cart item before adding to the cart.

$session_data ((string|mixed)[]) — An array of session data for coupon.
$item ((string|mixed)[]) — The coupon cart item.
$key (string) — The key of the coupon item.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_addons_multi_print_init_session` #

apply_filters( 'cctor_addons_multi_print_init_session', bool $init )

Filters whether the multi-print cart session should initialize on init for the current request. When false the session boots lazily on the first cart-aware render instead.

$init (bool) — Whether to initialize the session on init.

Since 3.5.2 · Source: src/Cctor/Multi_Print/Multi_Print_Provider.php

`cctor_addons_multi_print_is_rest_api_request` #

apply_filters( 'cctor_addons_multi_print_is_rest_api_request' )

Whether this is a REST API request.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Multi_Print_Provider.php

`cctor_addons_multi_print_page_url` #

apply_filters( 'cctor_addons_multi_print_page_url', string $url )

Allows filtering of the multiPrint page URL.

$url (string) — Defaults to home_url + /multiple-print/.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Url.php

`cctor_addons_multi_print_persistent_cart_enabled` #

apply_filters( 'cctor_addons_multi_print_persistent_cart_enabled', bool $ )

Filter whether multiPrint persistent cart is enabled.

$ (bool) — Whether the persistent cart is enabled. Default is true.

Since 3.4.0 · Source: src/Cctor/Multi_Print/Cart.php

`cctor_coupon_location_label_singular` #

apply_filters( 'cctor_coupon_location_label_singular', string $label )

Filters the singular label of the coupon Location taxonomy.

$label (string) — The singular label. Default ‘Location’.

Source: src/Cctor/Main.php

`cctor_coupon_location_label_singular_lowercase` #

apply_filters( 'cctor_coupon_location_label_singular_lowercase', string $label )

Filters the lowercase singular label of the coupon Location taxonomy.

$label (string) — The lowercase singular label. Default ‘location’.

Source: src/Cctor/Main.php

`cctor_coupon_location_plural` #

apply_filters( 'cctor_coupon_location_plural', string $label )

Filters the plural label of the coupon Location taxonomy.

$label (string) — The plural label. Default ‘Locations’.

Source: src/Cctor/Main.php

`cctor_coupon_location_plural_lowercase` #

apply_filters( 'cctor_coupon_location_plural_lowercase', string $label )

Filters the lowercase plural label of the coupon Location taxonomy.

$label (string) — The lowercase plural label. Default ‘locations’.

Source: src/Cctor/Main.php

`cctor_coupon_vendor_label_singular` #

apply_filters( 'cctor_coupon_vendor_label_singular', string $label )

Filters the singular label of the coupon Vendor taxonomy.

$label (string) — The singular label. Default ‘Vendor’.

Source: src/Cctor/Main.php

`cctor_coupon_vendor_label_singular_lowercase` #

apply_filters( 'cctor_coupon_vendor_label_singular_lowercase', string $label )

Filters the lowercase singular label of the coupon Vendor taxonomy.

$label (string) — The lowercase singular label. Default ‘vendor’.

Source: src/Cctor/Main.php

`cctor_coupon_vendor_plural` #

apply_filters( 'cctor_coupon_vendor_plural', string $label )

Filters the plural label of the coupon Vendor taxonomy.

$label (string) — The plural label. Default ‘Vendors’.

Source: src/Cctor/Main.php

`cctor_coupon_vendor_plural_lowercase` #

apply_filters( 'cctor_coupon_vendor_plural_lowercase', string $label )

Filters the lowercase plural label of the coupon Vendor taxonomy.

$label (string) — The lowercase plural label. Default ‘vendors’.

Source: src/Cctor/Main.php

`cctor_email_coupon_delivery_context` #

apply_filters( 'cctor_email_coupon_delivery_context', array $context, \Cctor__Coupon__Addons__Email__Coupon_Delivery $email )

Filters the variables passed to the Coupon Delivery email template.

$context (array) — Template variables: email, heading, custom_message, coupon, coupon_id, coupon_title, coupon_code, coupon_link, coupon_image, site_name, site_url.
$email (\Cctor__Coupon__Addons__Email__Coupon_Delivery) — The email instance.

`cctor_email_coupon_delivery_custom_message` #

apply_filters( 'cctor_email_coupon_delivery_custom_message', string $message, \Cctor__Coupon__Addons__Email__Coupon_Delivery $email )

Filters the additional message shown in the Coupon Delivery email.

$message (string) — The message after the admin setting and per-coupon overrides are applied.
$email (\Cctor__Coupon__Addons__Email__Coupon_Delivery) — The email instance.

`cctor_email_coupon_delivery_placeholders` #

apply_filters( 'cctor_email_coupon_delivery_placeholders', array $placeholders, \Cctor__Coupon__Addons__Email__Coupon_Delivery $email )

Filters the placeholder values available to the Coupon Delivery email.

$placeholders (array) — Values keyed by placeholder name, such as ‘coupon_code’.
$email (\Cctor__Coupon__Addons__Email__Coupon_Delivery) — The email instance.

`cctor_email_coupon_delivery_settings_fields` #

apply_filters( 'cctor_email_coupon_delivery_settings_fields', array $fields, \Cctor__Coupon__Addons__Email__Coupon_Delivery $email )

Filters the admin settings fields for the Coupon Delivery email.

$fields (array) — Settings field definitions keyed by field name.
$email (\Cctor__Coupon__Addons__Email__Coupon_Delivery) — The email instance.

`cctor_email_delivery_is_enabled` #

apply_filters( 'cctor_email_delivery_is_enabled', bool $enabled, int $coupon_id )

Filter whether email delivery is enabled for a coupon.

$enabled (bool) — Whether delivery is enabled
$coupon_id (int) — Coupon post ID

Since 3.5.0 · Source: src/Cctor/Email/Display.php

`cctor_email_delivery_should_show` #

apply_filters( 'cctor_email_delivery_should_show', bool|null $show_form, int $coupon_id, string $context )

Filter whether to show email delivery form based on context.

$show_form (bool|null) — Whether to show form (null for default behavior)
$coupon_id (int) — Coupon post ID
$context (string) — Current context

Since 3.5.0 · Source: src/Cctor/Email/Display.php

`cctor_email_gate_cookie_duration` #

apply_filters( 'cctor_email_gate_cookie_duration', int $duration, int $coupon_id )

Filter the email gate cookie duration.

$duration (int) — Duration in seconds
$coupon_id (int) — Coupon post ID

Since 3.5.0 · Source: src/Cctor/Email_Gate/Cookie.php

`cctor_email_gate_cookie_params` #

apply_filters( 'cctor_email_gate_cookie_params', array $params, int $coupon_id )

Filter the email gate cookie parameters.

$params (array) — Cookie parameters
$coupon_id (int) — Coupon post ID

Since 3.5.0 · Source: src/Cctor/Email_Gate/Cookie.php

`cctor_email_gate_custom_message` #

apply_filters( 'cctor_email_gate_custom_message', string $message, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the additional message shown in the Email Gate access email.

$message (string) — The message after the admin setting and per-coupon overrides are applied.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_gate_email_body` #

apply_filters( 'cctor_email_gate_email_body', string $body, int $coupon_id, string $access_url )

Filter the email gate body.

$body (string) — Email body.
$coupon_id (int) — Coupon post ID.
$access_url (string) — Access URL.

Since 3.5.0 · Source: src/Cctor/Email_Gate/REST.php

`cctor_email_gate_email_headers` #

apply_filters( 'cctor_email_gate_email_headers', array $headers, int $coupon_id )

Filter the email gate headers.

$headers (array) — Email headers.
$coupon_id (int) — Coupon post ID.

Since 3.5.0 · Source: src/Cctor/Email_Gate/REST.php

`cctor_email_gate_email_subject` #

apply_filters( 'cctor_email_gate_email_subject', string $subject, int $coupon_id )

Filter the email gate subject.

$subject (string) — Email subject.
$coupon_id (int) — Coupon post ID.

Since 3.5.0 · Source: src/Cctor/Email_Gate/REST.php

`cctor_email_gate_heading` #

apply_filters( 'cctor_email_gate_heading', string $heading, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the heading of the Email Gate access email.

$heading (string) — The heading after the admin setting override is applied.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_gate_is_enabled` #

apply_filters( 'cctor_email_gate_is_enabled', bool $enabled, int $coupon_id )

Filter whether email gate is enabled for a coupon.

$enabled (bool) — Whether gate is enabled
$coupon_id (int) — Coupon post ID

Since 3.5.0 · Source: src/Cctor/Email_Gate/Gate.php

`cctor_email_gate_placeholders` #

apply_filters( 'cctor_email_gate_placeholders', array $placeholders, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the placeholder values available to the Email Gate access email.

$placeholders (array) — Values keyed by placeholder name, such as ‘coupon_title’ and ‘access_link’.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_gate_preload_assets` #

apply_filters( 'cctor_email_gate_preload_assets', bool $preload )

Filter whether to preload email gate assets.

$preload (bool) — Whether to preload assets.

Since 3.5.0 · Source: src/Cctor/Email_Gate/Assets.php

`cctor_email_gate_settings_fields` #

apply_filters( 'cctor_email_gate_settings_fields', array $fields, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the admin settings fields for the Email Gate access email.

$fields (array) — Settings field definitions keyed by field name.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_gate_shortcodes` #

apply_filters( 'cctor_email_gate_shortcodes', array $shortcodes )

Filter the shortcodes to check for email gate asset preloading.

$shortcodes (array) — List of shortcode names.

Since 3.5.0 · Source: src/Cctor/Email_Gate/Assets.php

`cctor_email_gate_should_show` #

apply_filters( 'cctor_email_gate_should_show', bool $show_gate, int $coupon_id, string $context )

Filter whether to show gate based on context.

$show_gate (bool) — Whether to show gate
$coupon_id (int) — Coupon post ID
$context (string) — Current context

Since 3.5.0 · Source: src/Cctor/Email_Gate/Display.php

`cctor_email_gate_subject` #

apply_filters( 'cctor_email_gate_subject', string $subject, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the subject of the Email Gate access email.

$subject (string) — The subject after the admin setting and per-coupon overrides are applied.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_gate_template_context` #

apply_filters( 'cctor_email_gate_template_context', array $context, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the variables passed to the Email Gate access email template.

$context (array) — Template variables: email, heading, custom_message, coupon, coupon_id, coupon_title, coupon_link, access_link, site_name, site_url.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_gate_template_path` #

apply_filters( 'cctor_email_gate_template_path', string $plugin_path, \Cctor__Coupon__Addons__Email_Gate__Email $email )

Filters the plugin template path for the Email Gate access email.

Only applied when no theme override of the template was found.

$plugin_path (string) — Absolute path to the plugin’s email template file.
$email (\Cctor__Coupon__Addons__Email_Gate__Email) — The email instance.

`cctor_email_placeholders` #

apply_filters( 'cctor_email_placeholders', array $placeholders, \Cctor__Coupon__Addons__Email__Email_Abstract $email )

Filters the placeholder values shared by all of this plugin’s email types.

$placeholders (array) — Site and coupon values keyed by placeholder name.
$email (\Cctor__Coupon__Addons__Email__Email_Abstract) — The email instance.

Source: src/Cctor/Email/Email_Abstract.php

`cctor_email_rate_limit_per_hour` #

apply_filters( 'cctor_email_rate_limit_per_hour', int $max_per_hour )

Filters how many coupon emails one IP address may send per hour.

$max_per_hour (int) — Maximum sends per hour. Default 10.

Source: src/Cctor/Email/Service.php

`cctor_filter_dynamic_code_length` #

apply_filters( 'cctor_filter_dynamic_code_length', int $ )

Filter the dynamic code length options

$ (int) — 10 an integer

Source: src/Cctor/Meta/Fields.php

`cctor_location_slug` #

apply_filters( 'cctor_location_slug', string $slug )

Filters the Location taxonomy slug.

$slug (string) — The sanitized location slug from the options page.

Source: src/Cctor/Main.php

`cctor_query_is_coupon_location` #

apply_filters( 'cctor_query_is_coupon_location', bool $cctor_is_coupon_location )

Filters whether the current query is a coupon Location archive.

$cctor_is_coupon_location (bool) — Whether the main query was flagged as a coupon Location page.

Source: src/functions/template-tags/general.php

`cctor_query_is_coupon_vendor` #

apply_filters( 'cctor_query_is_coupon_vendor', bool $cctor_is_coupon_vendor )

Filters whether the current query is a coupon Vendor archive.

$cctor_is_coupon_vendor (bool) — Whether the main query was flagged as a coupon Vendor page.

Source: src/functions/template-tags/general.php

`cctor_sanitize_date` #

apply_filters( 'cctor_sanitize_date', string $date )

Filters the expiration date from the WooCommerce coupon form before it is saved as coupon meta.

The value has already passed through sanitize_text_field(). No callback is attached by default; hook here to normalize or validate the date.

$date (string) — The submitted expiration date.

`cctor_sanitize_dimensions` #

apply_filters( 'cctor_sanitize_dimensions', string $value )

Filters a numeric amount or limit from the WooCommerce coupon form before it is saved as coupon meta.

The value has already passed through sanitize_text_field(). No callback is attached by default; hook here to normalize or validate the number.

$value (string) — The submitted amount or limit.

`cctor_sanitize_text` #

apply_filters( 'cctor_sanitize_text', string $value )

Filters a text value from the WooCommerce coupon form before it is saved as coupon meta.

The value has already passed through sanitize_text_field(). No callback is attached by default; hook here to normalize or validate the value.

$value (string) — The submitted form value.