{"id":2215,"date":"2024-08-20T12:53:34","date_gmt":"2024-08-20T12:53:34","guid":{"rendered":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/?p=2215"},"modified":"2024-08-20T12:53:34","modified_gmt":"2024-08-20T12:53:34","slug":"actions","status":"publish","type":"post","link":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/","title":{"rendered":"Actions"},"content":{"rendered":"

init.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n

hook on init the plugin<\/p>\n

\n

templates\/shortcodes\/ywpar-customers-points.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n

hook before best users tabs<\/p>\n

\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n

hook after best users tabs<\/p>\n

\n

includes\/class-yith-wc-points-rewards-shortcodes.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n

hook before the checkout thresholds message<\/p>\n

\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n

hook after the checkout thresholds message<\/p>\n

\n

includes\/class-yith-wc-points-rewards-referral.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n

action description<\/p>\n

\nParams<\/b>\n int $order_id the ID of the order.<\/code>\n string $action the kind of action.<\/code>\n YITH_WC_Points_Rewards_Customer $customer_referral the referral user object.<\/code>\n<\/pre>\n
\n
includes\/class-yith-wc-points-rewards-redeeming.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
action triggered before return calculate price worth<\/p>\n
\nParams<\/b>\n<\/code>\n<\/pre>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook before apply discount calculation<\/p>\n
\n
includes\/class-yith-wc-points-rewards-post-types.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook before custom post type registration<\/p>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook after custom post type registration<\/p>\n
\n
includes\/class-yith-wc-points-rewards-orders.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
Hook on points added to the order<\/p>\n
\nParams<\/b>\n WC_Order $order the order.<\/code>\n<\/pre>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
action triggered before remove point to customer in a refund<\/p>\n
\nParams<\/b>\n int $total_points_to_refund the points to refund.<\/code>\n WC_Order $order the order.<\/code>\n<\/pre>\n
\n
includes\/class-yith-wc-points-rewards-frontend.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook before the rewards message<\/p>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
<\/p>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook before the rewards message<\/p>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook after the rewards message<\/p>\n
\n
includes\/class-yith-wc-points-rewards-extra-points.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hooks after login points given<\/p>\n
\nParams<\/b>\n YITH_WC_Points_Rewards_Customer $customer customer object<\/code>\n<\/pre>\n
\n
includes\/class-yith-wc-points-rewards-expiration-points.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook on the expired points email<\/p>\n
\nParams<\/b>\n array $args list of arguments.<\/code>\n<\/pre>\n
\n
includes\/class-yith-wc-points-rewards-email.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook on the update points email<\/p>\n
\nParams<\/b>\n array $args user email and email content.<\/code>\n<\/pre>\n
\n
includes\/class-yith-wc-points-rewards-earning.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
Hook on saved points earned from cart<\/p>\n
\nParams<\/b>\n WC_Order $order the order.<\/code>\n<\/pre>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
Hook on points added to the order<\/p>\n
\nParams<\/b>\n WC_Order $order the order.<\/code>\n<\/pre>\n
\n
includes\/class-yith-wc-points-rewards-customer.php<\/h3>\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook on banning a user<\/p>\n
\nParams<\/b>\n YITH_WC_Points_Rewards_Customer $user the user.<\/code>\n<\/pre>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook on customer updated points<\/p>\n
\nParams<\/b>\n int $customer_id customer id.<\/code>\n int $points_amount the points updated.<\/code>\n string $action type of the action.<\/code>\n array $arguments list of arguments.<\/code>\n<\/pre>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
Points earned<\/p>\n
\n\t
\n\t\t
\n\t\t\t\n\t\t\t
Copied!<\/div>\n\t\t<\/div>\n\t\t
\n\t\t\t<\/i>\n\t\t\tCopy<\/span>\n\t\t<\/div>\n\t<\/div>\n
hook on updated level<\/p>\n
\nParams<\/b>\n int $new_customer_level the new level.<\/code>\n int $customer_level actual level.<\/code>\n YITH_WC_Points_Rewards_Customer $this customer object.<\/code>\n<\/pre>\n
\n<\/div>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":20,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-2215","post","type-post","status-publish","format-standard","hentry","category-development"],"yoast_head":"\nActions - YITH WooCommerce Points and Rewards<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Actions - YITH WooCommerce Points and Rewards\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/\" \/>\n<meta property=\"og:site_name\" content=\"YITH WooCommerce Points and Rewards\" \/>\n<meta property=\"article:published_time\" content=\"2024-08-20T12:53:34+00:00\" \/>\n<meta name=\"author\" content=\"armando\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"armando\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/\",\"url\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/\",\"name\":\"Actions - YITH WooCommerce Points and Rewards\",\"isPartOf\":{\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#website\"},\"datePublished\":\"2024-08-20T12:53:34+00:00\",\"author\":{\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#\/schema\/person\/c617ea3a2e5ee161586c2bc0d367ffe3\"},\"breadcrumb\":{\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Actions\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#website\",\"url\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/\",\"name\":\"YITH WooCommerce Points and Rewards\",\"description\":\"Plugin documentation\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#\/schema\/person\/c617ea3a2e5ee161586c2bc0d367ffe3\",\"name\":\"armando\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/6020f46edbc3814f7508e28543747a01?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/6020f46edbc3814f7508e28543747a01?s=96&d=mm&r=g\",\"caption\":\"armando\"},\"url\":\"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/author\/armando\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Actions - YITH WooCommerce Points and Rewards","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/","og_locale":"en_US","og_type":"article","og_title":"Actions - YITH WooCommerce Points and Rewards","og_url":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/","og_site_name":"YITH WooCommerce Points and Rewards","article_published_time":"2024-08-20T12:53:34+00:00","author":"armando","twitter_card":"summary_large_image","twitter_misc":{"Written by":"armando","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/","url":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/","name":"Actions - YITH WooCommerce Points and Rewards","isPartOf":{"@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#website"},"datePublished":"2024-08-20T12:53:34+00:00","author":{"@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#\/schema\/person\/c617ea3a2e5ee161586c2bc0d367ffe3"},"breadcrumb":{"@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/development\/actions\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/"},{"@type":"ListItem","position":2,"name":"Actions"}]},{"@type":"WebSite","@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#website","url":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/","name":"YITH WooCommerce Points and Rewards","description":"Plugin documentation","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#\/schema\/person\/c617ea3a2e5ee161586c2bc0d367ffe3","name":"armando","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/6020f46edbc3814f7508e28543747a01?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/6020f46edbc3814f7508e28543747a01?s=96&d=mm&r=g","caption":"armando"},"url":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/author\/armando\/"}]}},"_links":{"self":[{"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/posts\/2215","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/users\/20"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/comments?post=2215"}],"version-history":[{"count":2,"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/posts\/2215\/revisions"}],"predecessor-version":[{"id":2285,"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/posts\/2215\/revisions\/2285"}],"wp:attachment":[{"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/media?parent=2215"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/categories?post=2215"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.yithemes.com\/yith-woocommerce-points-and-rewards\/wp-json\/wp\/v2\/tags?post=2215"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}