Actions and filters available to developers extending Coupon Creator. This reference is generated from the plugin source on each release.
Actions (42) #
'cctor_core_pre_get_template_part_' . $slug$is_print_view ? 'cctor_print_coupon_deal' : 'cctor_coupon_deal'$is_print_view ? 'cctor_print_coupon_expiration' : 'cctor_coupon_expiration'$is_print_view ? 'cctor_print_coupon_terms' : 'cctor_coupon_terms'cctor_action_print_templatecctor_activatecctor_add_meta_boxcctor_admin_assetscctor_after_couponcctor_before_couponcctor_before_coupon_inner_wrapcctor_before_coupon_wrapcctor_click_actionscctor_click_to_print_couponcctor_core_after_get_template_partcctor_core_before_get_template_partcctor_coupon_dealcctor_coupon_expirationcctor_coupon_linkcctor_coupon_parse_querycctor_coupon_termscctor_deactivatecctor_img_couponcctor_inside_remove_coupons_from _searchcctor_no_show_couponcctor_print_after_couponcctor_print_before_couponcctor_print_coupon_dealcctor_print_coupon_expirationcctor_print_coupon_termscctor_print_image_couponcctor_print_no_show_couponcctor_print_template_functionscctor_shortcode_endcctor_shortcode_startcctor_shortcode_template_functionscoupon_creator_plugin_failed_to_loadcoupon_creator_plugin_loadedcoupon_footercoupon_print_headcoupon_print_metapngx_meta_message
'cctor_core_pre_get_template_part_' . $slug #
do_action( ''cctor_core_pre_get_template_part_' . $slug', string $slug, null|string $name, array|null $data )
Fires before a coupon template part is loaded.
$slug(string) —$name(null|string) —$data(array|null) —
Source: src/functions/template-tags/templates.php
$is_print_view ? 'cctor_print_coupon_deal' : 'cctor_coupon_deal' #
do_action( '$is_print_view ? 'cctor_print_coupon_deal' : 'cctor_coupon_deal'', int $coupon_id )
Coupon Deal Hook
$coupon_id(int) —
Source: src/views/type/ticket.php
$is_print_view ? 'cctor_print_coupon_expiration' : 'cctor_coupon_expiration' #
do_action( '$is_print_view ? 'cctor_print_coupon_expiration' : 'cctor_coupon_expiration'', int $coupon_id, object $coupon_expiration )
Coupon Expiration Display Hook
$coupon_id(int) —$coupon_expiration(object) —
Source: src/views/type/ticket.php
$is_print_view ? 'cctor_print_coupon_terms' : 'cctor_coupon_terms' #
do_action( '$is_print_view ? 'cctor_print_coupon_terms' : 'cctor_coupon_terms'', int $coupon_id )
Coupon Terms Hook
$coupon_id(int) —
Source: src/views/type/ticket.php
cctor_action_print_template #
do_action( 'cctor_action_print_template', int $coupon_id )
Fires at the top of the single-coupon print template, before any output.
Pro redirects away here when the coupon disables its print view, and Add-ons read the dynamic code cookie before the coupon renders.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_activate #
do_action( 'cctor_activate' )
Fires on Activation of Coupon Creator
Avaiable when Pro is decativated users who have activate_plugins capability
Source: src/Cctor/Main.php
cctor_add_meta_box #
do_action( 'cctor_add_meta_box' )
Additional Coupons Hook
Source: src/Cctor/Admin/Meta.php
cctor_admin_assets #
do_action( 'cctor_admin_assets' )
Fires after Coupon Creator enqueues its admin styles and scripts.
Runs only on the coupon edit screens and the options pages. Add-ons use it to enqueue the WooCommerce meta box assets.
Source: src/Cctor/Assets.php
cctor_after_coupon #
do_action( 'cctor_after_coupon', int $coupon_id )
After Core Shortcode Wrap
$coupon_id(int) —
Source: src/Cctor/Shortcode.php
cctor_before_coupon #
do_action( 'cctor_before_coupon', int $coupon_id )
Before Core Coupon Shortcode Individual Coupon
$coupon_id(int) —
Source: src/Cctor/Shortcode.php
cctor_before_coupon_inner_wrap #
do_action( 'cctor_before_coupon_inner_wrap', int $coupon_id )
Before Core Shortcode Individual Coupon Wrap
$coupon_id(int) —
Source: src/Cctor/Shortcode.php
cctor_before_coupon_wrap #
do_action( 'cctor_before_coupon_wrap' )
Before Core Coupon Shortcode Wrap
Since 1.90 · Source: src/Cctor/Shortcode.php
cctor_click_actions #
do_action( 'cctor_click_actions', int $coupon_id, object $coupon_expiration )
Coupon Click Actions
$coupon_id(int) —$coupon_expiration(object) —
Source: src/views/type/ticket.php
cctor_click_to_print_coupon #
do_action( 'cctor_click_to_print_coupon', int $coupon_id )
Fires to output the Click to Print button under a printed coupon.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_core_after_get_template_part #
do_action( 'cctor_core_after_get_template_part', string $template, string $file )
Fires after the template part is included.
$template(string) —$file(string) —
Source: src/functions/template-tags/templates.php
cctor_core_before_get_template_part #
do_action( 'cctor_core_before_get_template_part', string $template, string $file )
Fires before the template part is included.
$template(string) —$file(string) —
Source: src/functions/template-tags/templates.php
cctor_coupon_deal #
do_action( 'cctor_coupon_deal', int $coupon_id )
Coupon Deal Hook
$coupon_id(int) —
Source: src/Cctor/Shortcode.php
cctor_coupon_expiration #
do_action( 'cctor_coupon_expiration', int $coupon_id, object $coupon_expiration )
Coupon Expiration Display Hook
Image coupons gate on the expiration date like text coupons, so the date has to be visible on them too.
$coupon_id(int) —$coupon_expiration(object) —
Source: src/Cctor/Shortcode.php
cctor_coupon_link #
do_action( 'cctor_coupon_link', int $coupon_id )
Individual Coupon Link
$coupon_id(int) —
Source: src/Cctor/Shortcode.php
cctor_coupon_parse_query #
do_action( 'cctor_coupon_parse_query' )
Parse Coupon Query Action
Source: src/Cctor/Main.php
cctor_coupon_terms #
do_action( 'cctor_coupon_terms', int $coupon_id )
Coupon Terms Hook
$coupon_id(int) —
Source: src/Cctor/Shortcode.php
cctor_deactivate #
do_action( 'cctor_deactivate' )
Fires on deactivation of Coupon Creator
Avaiable when Pro is decativated users who have activate_plugins capability
Source: src/Cctor/Main.php
cctor_img_coupon #
do_action( 'cctor_img_coupon', int $coupon_id, string $couponimage, array $cctor_atts )
Display Coupon Image Hook
$coupon_id(int) —$couponimage(string) —$cctor_atts(array) — [‘bordertheme’]
Source: src/Cctor/Shortcode.php
cctor_inside_remove_coupons_from _search #
do_action( 'cctor_inside_remove_coupons_from _search' )
Fires on search results
The hook includes the $query global and fires on search results, but can be used to disable the coupon creator from specifying the post types for search
Since 2.3.0 · Source: src/Cctor/Search.php
cctor_no_show_coupon #
do_action( 'cctor_no_show_coupon', int $coupon_id, \Cctor__Coupon__Expiration $coupon_expiration, string $coupon_align )
Fires in place of a coupon that is expired or hidden in the shortcode output.
Core prints an HTML comment with the expiration date, plus a visible notice for users who may view diagnostics.
$coupon_id(int) — Coupon post ID.$coupon_expiration(\Cctor__Coupon__Expiration) — Expiration object for the coupon. Pro passes its own subclass.$coupon_align(string) — Alignment class from the shortcode, ‘cctor_alignnone’ by default.
Source: src/Cctor/Shortcode.php
cctor_print_after_coupon #
do_action( 'cctor_print_after_coupon', int $coupon_id )
Fires after each coupon renders in the print template, inside the loop.
Pro prints the print-only content here, and Add-ons output the email form or the email gate here.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_print_before_coupon #
do_action( 'cctor_print_before_coupon', int $coupon_id )
Fires before each coupon renders in the print template, inside the loop.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_print_coupon_deal #
do_action( 'cctor_print_coupon_deal', int $coupon_id )
Fires to output the deal text of a printed coupon.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_print_coupon_expiration #
do_action( 'cctor_print_coupon_expiration', int $coupon_id, \Cctor__Coupon__Expiration $coupon_expiration )
Fires to output the expiration date of a printed coupon.
$coupon_id(int) — Coupon post ID.$coupon_expiration(\Cctor__Coupon__Expiration) — Expiration object for the coupon. Pro passes its own subclass.
Source: src/functions/templates/print-coupon.php
cctor_print_coupon_terms #
do_action( 'cctor_print_coupon_terms', int $coupon_id )
Fires to output the terms of a printed coupon.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_print_image_coupon #
do_action( 'cctor_print_image_coupon', int $coupon_id, string $couponimage )
Fires to output an image coupon in the print template.
$coupon_id(int) — Coupon post ID.$couponimage(string) — URL of the coupon image.
Source: src/functions/templates/print-coupon.php
cctor_print_no_show_coupon #
do_action( 'cctor_print_no_show_coupon', int $coupon_id, \Cctor__Coupon__Expiration $coupon_expiration )
Fires in place of a coupon that is expired or hidden in the print template.
Core prints an HTML comment with the expiration date, plus a visible notice for users who may view diagnostics.
$coupon_id(int) — Coupon post ID.$coupon_expiration(\Cctor__Coupon__Expiration) — Expiration object for the coupon. Pro passes its own subclass.
Source: src/functions/templates/print-coupon.php
cctor_print_template_functions #
do_action( 'cctor_print_template_functions' )
Print Template Hook for all Action and Filters
Since 1.90 · Source: src/functions/template-build/cctor-print-build.php
cctor_shortcode_end #
do_action( 'cctor_shortcode_end' )
End Core Shortcode
Source: src/Cctor/Shortcode.php
cctor_shortcode_start #
do_action( 'cctor_shortcode_start' )
Core Coupon Shortcode Starting Hook
Source: src/Cctor/Shortcode.php
cctor_shortcode_template_functions #
do_action( 'cctor_shortcode_template_functions' )
Shortcode Template Hook for all Action and Filters
Since 1.90 · Source: src/functions/template-build/cctor-shortcode-build.php
coupon_creator_plugin_failed_to_load #
do_action( 'coupon_creator_plugin_failed_to_load' )
Fires if Coupon Creat cannot load due to compatibility or other problems.
Source: src/Cctor/Main.php
coupon_creator_plugin_loaded #
do_action( 'coupon_creator_plugin_loaded' )
Fires once Coupon Creator has completed basic setup.
Source: src/Cctor/Main.php
coupon_footer #
do_action( 'coupon_footer' )
Fires at the end of the print template body, after the coupon loop.
Pro prints its iframe resize script here.
Source: src/functions/templates/print-coupon.php
coupon_print_head #
do_action( 'coupon_print_head' )
Fires inside the <head> of the print template, after the meta hook.
Core prints the custom CSS from the options page here.
Source: src/functions/templates/print-coupon.php
coupon_print_meta #
do_action( 'coupon_print_meta' )
Fires inside the <head> of the print template, before the head hook.
Core prints the charset and viewport meta, the title, the base print CSS, and the coupon stylesheet here.
Source: src/functions/templates/print-coupon.php
pngx_meta_message #
do_action( 'pngx_meta_message', int $coupon_id )
Display Message on Individual Coupon Editor Page
$coupon_id(int) —
Since 1.90 · Source: src/Cctor/Admin/Meta.php
Filters (51) #
'cctor_coupon_template_' . $template'cctor_shortcode_query_args_' . $filteridcctor_category_slugcctor_contrast_inkcctor_core_get_template_part_pathcctor_core_get_template_part_templatescctor_coupon_category_label_singularcctor_coupon_category_label_singular_lowercasecctor_coupon_category_pluralcctor_coupon_category_plural_lowercasecctor_coupon_incomplete_reasonscctor_coupon_label_pluralcctor_coupon_label_plural_lowercasecctor_coupon_label_singularcctor_coupon_label_singular_lowercasecctor_coupon_slugcctor_coupon_templatecctor_coupon_template_pathscctor_coupon_tokenscctor_deal_inline_stylecctor_default_totalcouponscctor_docs_base_urlcctor_filter_column_casescctor_filter_coupon_list_columnscctor_filter_ignore_expirationcctor_filter_inline_csscctor_filter_meta_fieldscctor_filter_meta_show_coupon_checkcctor_filter_meta_tabscctor_filter_meta_template_fieldscctor_filter_searchable_post_typescctor_getting_started_urlcctor_image_urlcctor_img_sizecctor_inner_content_wrapcctor_is_couponcctor_option_filtercctor_option_sectionscctor_options_header_versionscctor_outer_content_wrapcctor_print_image_urlcctor_print_inner_content_wrapcctor_print_outer_content_wrapcctor_query_is_coupon_categorycctor_query_is_coupon_querycctor_query_is_coupon_taxonomycctor_sdk_licensescctor_shortcode_query_argscctor_telemetry_extensionscctor_ticket_extra_fieldscoupon_creator_supported_system_version
'cctor_coupon_template_' . $template #
apply_filters( ''cctor_coupon_template_' . $template', string|false $file )
Filter the resolved path for one specific template.
$file(string|false) — The full path to the template, or false.
Source: src/Cctor/Templates.php
'cctor_shortcode_query_args_' . $filterid #
apply_filters( ''cctor_shortcode_query_args_' . $filterid', array $cctor_args )
Filter Core ShortCode Query Arguments by ID
$cctor_args(array) — .
Source: src/Cctor/Shortcode.php
cctor_category_slug #
apply_filters( 'cctor_category_slug', string $slug )
Filters the coupon category taxonomy slug.
$slug(string) — The sanitized category slug from the options page.
Source: src/Cctor/Post_Type_Coupon.php
cctor_contrast_ink #
apply_filters( 'cctor_contrast_ink', string $ink, string $background, float $luminance )
Filter the computed ink colour for a given background.
$ink(string) — The chosen ink colour.$background(string) — The background colour it was computed from.$luminance(float) — The computed relative luminance.
Since 3.6.0 · Source: src/functions/template-functions/cctor-function-tokens.php
cctor_core_get_template_part_path #
apply_filters( 'cctor_core_get_template_part_path', string|false $file, string $template, string $slug, null|string $name )
Filter the resolved file path for a template part.
$file(string|false) —$template(string) —$slug(string) —$name(null|string) —
Source: src/functions/template-tags/templates.php
cctor_core_get_template_part_templates #
apply_filters( 'cctor_core_get_template_part_templates', array $templates, string $slug, null|string $name )
Filter the candidate template files for this part.
$templates(array) —$slug(string) —$name(null|string) —
Source: src/functions/template-tags/templates.php
cctor_coupon_category_label_singular #
apply_filters( 'cctor_coupon_category_label_singular', string $label )
Filters the singular label for coupon categories.
$label(string) — Translated label, ‘Coupon Category’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_category_label_singular_lowercase #
apply_filters( 'cctor_coupon_category_label_singular_lowercase', string $label )
Filters the lowercase singular label for coupon categories.
$label(string) — Translated label, ‘coupon category’ by default.
Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_category_plural #
apply_filters( 'cctor_coupon_category_plural', string $label )
Filters the plural label for coupon categories.
$label(string) — Translated label, ‘Coupon Categories’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_category_plural_lowercase #
apply_filters( 'cctor_coupon_category_plural_lowercase', string $label )
Filters the lowercase plural label for coupon categories.
$label(string) — Translated label, ‘coupon categories’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_incomplete_reasons #
apply_filters( 'cctor_coupon_incomplete_reasons', string[] $reasons, int $coupon_id )
Filter the incomplete-coupon reasons shown to editors.
$reasons(string[]) — Reasons the coupon renders broken/empty.$coupon_id(int) — Coupon ID.
Source: src/Cctor/Admin/Usability.php
cctor_coupon_label_plural #
apply_filters( 'cctor_coupon_label_plural', string $label )
Filters the plural label for coupons.
$label(string) — Translated label, ‘Coupons’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_label_plural_lowercase #
apply_filters( 'cctor_coupon_label_plural_lowercase', string $label )
Filters the lowercase plural label for coupons.
$label(string) — Translated label, ‘coupons’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_label_singular #
apply_filters( 'cctor_coupon_label_singular', string $label )
Filters the singular label for coupons.
$label(string) — Translated label, ‘Coupon’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_label_singular_lowercase #
apply_filters( 'cctor_coupon_label_singular_lowercase', string $label )
Filters the lowercase singular label for coupons.
$label(string) — Translated label, ‘coupon’ by default.
Since 3.0 · Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_slug #
apply_filters( 'cctor_coupon_slug', string $slug )
Filters the coupon post type slug.
$slug(string) — The sanitized coupon slug from the options page.
Source: src/Cctor/Post_Type_Coupon.php
cctor_coupon_template #
apply_filters( 'cctor_coupon_template', string $candidate, string $template )
Filter the resolved coupon template path.
$candidate(string) — The full path to the template.$template(string) — The template name.
Source: src/Cctor/Templates.php
cctor_coupon_template_paths #
apply_filters( 'cctor_coupon_template_paths', array $paths )
Filter base paths searched for coupon templates.
Shared with Coupon Creator Pro, which registers the same filter.
$paths(array) — An array of plugin base paths.
Source: src/Cctor/Templates.php
cctor_coupon_tokens #
apply_filters( 'cctor_coupon_tokens', array $tokens, int $coupon_id )
Filter the design tokens set on a coupon container.
$tokens(array) — Map of custom property name to value.$coupon_id(int) — The coupon post ID.
Since 3.6.0 · Source: src/functions/template-functions/cctor-function-tokens.php
cctor_deal_inline_style #
apply_filters( 'cctor_deal_inline_style', string $deal_style, int $coupon_id )
Filter the inline style on the deal element.
Templates that colour the deal through CSS custom properties rather than per-element inline styles (the ticket type, for example) return an empty string here so the inline values cannot beat the stylesheet.
$deal_style(string) — The already-escaped inline style attribute value.$coupon_id(int) — The coupon post ID.
Since 3.6.0 · Source: src/functions/template-functions/cctor-function-deal.php
cctor_default_totalcoupons #
apply_filters( 'cctor_default_totalcoupons', int $default_totalcoupons )
Filter the default number of coupons a bare
Print Only
Both this coupon’s deal headline and part of its content only appear when it is printed. Open the print view to see them.
Reveal a unique code per visitor, saved to a cookie the moment they click.
A clean logo, discount banner, title, and offer — the Modern template from Add-ons.
Layer the lower-third band over any background image for extra emphasis.
Starter
$49
One site, all core features
Plus
$99
Five sites, every add-on
Click to Reveal
Reveal Coupon #
Click the button to reveal and copy the code — Coupon Creator tracks the click and can open a link at the same time.
Template columns
Split the coupon into two editable columns with their own colors.
View counter
This coupon counts its views — see the running total below.
Browse live examples of every Coupon Creator feature, from borders to templates to reveal codes.
Guides for every option — templates, expiration modes, shortcodes and more.
Evergreen Expiration
X Days Expiration #
This coupon expires a set number of days after it is printed — perfect for evergreen offers that still feel urgent.
Turn the border off entirely and let the background define the coupon.
Send Them Anywhere
Pro Custom/Affiliate Links #
Point the coupon’s link anywhere — a landing page, a partner site, or an affiliate URL — instead of the print view.
Works At Checkout
WooCommerce #
Create WooCommerce coupon codes right from Coupon Creator with the Add-ons, and display them inside your coupon.
Content Per View
Pro View Shortcodes #
This paragraph only appears when the coupon is embedded with a shortcode.
Use the showhook and showprint tags to vary content between the shortcode, single, and print views.
Layer a background color or pattern behind the coupon, then spotlight a product with an image under the title.
Popup Print View
Pro Popup Coupon #
The print view for this coupon opens in a popup and can be printed right from there. The counter below tracks views.
Coupon Creator Add-ons
Explore the Add-ons #
Advanced templates, reveal and dynamic codes, email delivery, and WooCommerce coupons — all in the Add-ons.
Free on WordPress.org
Get the Coupon Creator #
Download Coupon Creator free from WordPress.org and start publishing coupons today.
Coupon Creator Pro
Get Started With Pro #
Unlock the coupon loop, five border styles, recurring expiration, and popup print views.
Coupon Creator
Standard Coupon #
Coupon Creator is free on WordPress.org. Build a coupon like this in minutes, then upgrade to Pro for borders, loops, and more.
$default_totalcoupons(int) — Default cap when totalcoupons is omitted.
Source: src/Cctor/Shortcode.php
cctor_docs_base_url #
apply_filters( 'cctor_docs_base_url', string $base )
Filters the base URL of the Artifex documentation site.
$base(string) — Documentation base URL, trailing-slashed.
Source: src/functions/template-tags/general.php
cctor_filter_column_cases #
apply_filters( 'cctor_filter_column_cases', string $column, int $post_id, object $coupon_expiration )
Filter the Admin Coupon List Columns Information per Coupon
$column(string) — a string of data to display in the admin columns.$post_id(int) — an integer of the coupon post$coupon_expiration(object) — the expiration object.
Since 1.80 · Source: src/Cctor/Admin/Columns.php
cctor_filter_coupon_list_columns #
apply_filters( 'cctor_filter_coupon_list_columns', array $cctor_columns )
Filter the Admin Coupon List Columns Headers
$cctor_columns(array) — an array of column headers.
Source: src/Cctor/Admin/Columns.php
cctor_filter_ignore_expiration #
apply_filters( 'cctor_filter_ignore_expiration', bool $show_coupon, int $coupon_id )
Filters whether a coupon is current and may show.
Return true to show a coupon that is outside its start and expiration dates, or false to hide one that is current. Add-ons use this to hide a dynamic-code coupon once its codes are used up.
$show_coupon(bool) — Whether the coupon is within its start and expiration dates.$coupon_id(int) — Coupon post ID.
Source: src/Cctor/Expiration.php
cctor_filter_inline_css #
apply_filters( 'cctor_filter_inline_css', array $cctor_img_size )
Filter Print View Inline Styles
$cctor_img_size(array) — .
Source: src/Cctor/Print.php
cctor_filter_meta_fields #
apply_filters( 'cctor_filter_meta_fields', array $fields )
Filter the meta fields from Coupon Creator
$fields(array) — an array of fields to display in meta tabs.
Source: src/Cctor/Meta/Order.php
cctor_filter_meta_show_coupon_check #
apply_filters( 'cctor_filter_meta_show_coupon_check', bool $coupon_hidden, int $coupon_id )
Filters whether a coupon is hidden by an extra restriction.
Return true to hide a coupon that is otherwise current.
$coupon_hidden(bool) — Whether the coupon is hidden. False by default.$coupon_id(int) — Coupon post ID.
Source: src/Cctor/Expiration.php
cctor_filter_meta_tabs #
apply_filters( 'cctor_filter_meta_tabs', array $tabs )
Filter the Coupon Creator Meta Tab Header
$tabs(array) — an array of tab headings.
Source: src/Cctor/Admin/Meta.php
cctor_filter_meta_template_fields #
apply_filters( 'cctor_filter_meta_template_fields', array $fields )
Filter the meta fields from Coupon Creator for custom templates
$fields(array) — an array of fields to display in meta tabs.
Source: src/Cctor/Meta/Order.php
cctor_filter_searchable_post_types #
apply_filters( 'cctor_filter_searchable_post_types', array $searchable_cpt )
Filter the searchable custom post types
$searchable_cpt(array) — an array of post types to include in search
Source: src/Cctor/Search.php
cctor_getting_started_url #
apply_filters( 'cctor_getting_started_url', string $url )
Filter the getting-started guide URL used in wp-admin.
$url(string) — Getting-started guide URL.
Source: src/Cctor/Admin/Usability.php
cctor_image_url #
apply_filters( 'cctor_image_url', int $coupon_id, string $size )
Filters the image URL of an image coupon.
Return a non-empty URL to render the coupon as an image.
$coupon_id(int) — Coupon post ID.$size(string) — Image size.
Source: src/Cctor/Shortcode.php
cctor_img_size #
apply_filters( 'cctor_img_size', array $cctor_img_size )
Filter Image Coupon Image Sizes
$cctor_img_size(array) —
Source: src/Cctor/Images.php
cctor_inner_content_wrap #
apply_filters( 'cctor_inner_content_wrap', int $coupon_id, string|null $coupon_align, string $cctor_atts )
Filter Individual Coupon Inner Wrap
$coupon_id(int) — .$coupon_align(string|null) — .$cctor_atts(string) — [‘bordertheme’] .
Source: src/Cctor/Shortcode.php
cctor_is_coupon #
apply_filters( 'cctor_is_coupon', bool $is_coupon, int|null $postId )
Filters whether a post is a coupon.
$is_coupon(bool) — Whether the post is a coupon post type.$postId(int|null) — Post ID being checked, or null for the current post.
Source: src/functions/template-tags/general.php
cctor_option_filter #
apply_filters( 'cctor_option_filter', array $this )
Filter the options fields from Coupon Creator
$this(array) — ->options an array of fields to display in option tabs.
Source: src/Cctor/Admin/Options.php
cctor_option_sections #
apply_filters( 'cctor_option_sections', array $meta_tabs )
Filter the Coupon Creator Option Tab Header
$meta_tabs(array) — an array of tab headings.
Source: src/Cctor/Admin/Options.php
cctor_options_header_versions #
apply_filters( 'cctor_options_header_versions', string[] $version_parts )
Filters the version strings shown in the options header band.
Core supplies its own version from the constant; active tiers append theirs (see Pro’s pro_version() and Add-ons’ version()). The parts render joined with ” · “, e.g. “v3.6.0 · Pro 3.6.0 · Add-ons 3.6.0”.
$version_parts(string[]) — Version strings in display order.
Source: src/Cctor/Admin/Options.php
cctor_outer_content_wrap #
apply_filters( 'cctor_outer_content_wrap', int $coupon_id, string|null $coupon_align, string $cctor_atts )
Filter Individual Coupon Outer Wrap
$coupon_id(int) — .$coupon_align(string|null) — .$cctor_atts(string) — [‘bordertheme’] .
Source: src/Cctor/Shortcode.php
cctor_print_image_url #
apply_filters( 'cctor_print_image_url', int $coupon_id, string $size )
Filters the image URL used when a coupon prints as an image.
The value passed in is the coupon ID. The default callback returns the URL of the coupon image, or an empty string when the coupon has no image and should print its deal and terms instead.
$coupon_id(int) — Coupon post ID.$size(string) — Image size name handed to the callback. The print template passes ‘print_coupon’.
Source: src/functions/templates/print-coupon.php
cctor_print_inner_content_wrap #
apply_filters( 'cctor_print_inner_content_wrap', int $coupon_id )
Filters the inner wrapper markup of a printed coupon.
The value passed in is the coupon ID. The default callback returns an array with ‘start_wrap’ and ‘end_wrap’ HTML strings that enclose the deal, the terms, and the expiration date.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_print_outer_content_wrap #
apply_filters( 'cctor_print_outer_content_wrap', int $coupon_id )
Filters the outer wrapper markup of a printed coupon.
The value passed in is the coupon ID. The default callback returns an array with ‘start_wrap’ and ‘end_wrap’ HTML strings that enclose the whole coupon.
$coupon_id(int) — Coupon post ID.
Source: src/functions/templates/print-coupon.php
cctor_query_is_coupon_category #
apply_filters( 'cctor_query_is_coupon_category', bool $cctor_is_coupon_category )
Filters whether the current page is a coupon category page.
$cctor_is_coupon_category(bool) — Whether the main query flagged a coupon category.
Source: src/functions/template-tags/general.php
cctor_query_is_coupon_query #
apply_filters( 'cctor_query_is_coupon_query', bool $cctor_is_coupon_query )
Filters whether the current page displays a coupon query.
$cctor_is_coupon_query(bool) — Whether the main query flagged a coupon query.
Source: src/functions/template-tags/general.php
cctor_query_is_coupon_taxonomy #
apply_filters( 'cctor_query_is_coupon_taxonomy', bool $cctor_is_coupon_taxonomy )
Filters whether the current page displays a coupon taxonomy.
$cctor_is_coupon_taxonomy(bool) — Whether the main query flagged a coupon taxonomy.
Source: src/functions/template-tags/general.php
cctor_sdk_licenses #
apply_filters( 'cctor_sdk_licenses', array[] $licenses )
Filters the paid-plugin licenses shown in the License card on the options page.
Pro and Add-ons each append a descriptor with ‘item_id’, ‘slug’, ‘name’, and ‘status_option’ keys.
$licenses(array[]) — License descriptors. Empty by default.
Source: src/Cctor/Admin/SDK_License_UI.php
cctor_shortcode_query_args #
apply_filters( 'cctor_shortcode_query_args', array $cctor_args )
Filter Core ShortCode Query Arguments
$cctor_args(array) — .
Source: src/Cctor/Shortcode.php
cctor_telemetry_extensions #
apply_filters( 'cctor_telemetry_extensions', array $extensions )
Extensions to report with core’s check-in, as slug => version.
Keys are permanent product slugs — they are what the server reports on, so they must not be renamed once shipped.
$extensions(array) —
Since 3.6 · Source: coupon_creator.php
cctor_ticket_extra_fields #
apply_filters( 'cctor_ticket_extra_fields', string[] $field_ids, int $coupon_id )
Filter the field IDs the ticket renders through `Pngx__Fields`.
The ticket writes its own markup instead of looping every field, so field-driven add-ons — click-reveal, dynamic codes — have nowhere to land. They have no action of their own to hook, so each one opts in here by ID and is rendered in the body. Deal, terms and expiration are deliberately absent: the ticket already fires their shared actions below, and listing them here would render them twice.
$field_ids(string[]) — Field IDs to render inside the ticket body.$coupon_id(int) — The coupon post ID.
Since 3.6.0 · Source: src/views/type/ticket.php
coupon_creator_supported_system_version #
apply_filters( 'coupon_creator_supported_system_version', string $system, bool $supported )
Filter whether the current version of PHP or WordPress is supported.
$system(string) — Which system to test the version of such as ‘php’ or ‘wordpress’.$supported(bool) — Whether the current version of PHP or WordPress is supported.
Since 3.0 · Source: src/Cctor/Main.php