{"id":150,"date":"2024-05-07T04:05:13","date_gmt":"2024-05-07T04:05:13","guid":{"rendered":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/?p=150"},"modified":"2024-05-07T04:05:13","modified_gmt":"2024-05-07T04:05:13","slug":"hooks-reference","status":"publish","type":"post","link":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/","title":{"rendered":"Hooks Reference"},"content":{"rendered":"<p>Below is a full list of actions &amp; filters in our plugin<\/p>\n<ul>\n<li><b>Actions<\/b>\n<ul>\n<li><strong>wc_deposits_enqueue_product_scripts<\/strong>\u00a0: this action is triggered when deposit buttons template is loaded on single product page<\/li>\n<li><strong>wc_deposits_enqueue_deposit_button_scripts<\/strong>\u00a0: this action is triggered when deposit buttons template is loaded on checkout page when checkout mode is enabled<\/li>\n<li><strong>wc_deposits_after_settings_tabs_content<\/strong>\u00a0: this action could be used to output the html for an extra tab body in plugin settings<\/li>\n<li><strong>wc_deposits_settings_tabs_general_tab<\/strong>\u00a0: this action could be used to output any extra fields in general tab, plugin settings<\/li>\n<li><strong>wc_deposits_settings_tabs_display_text_tab<\/strong>\u00a0: this action could be used to output any extra fields in display &amp; text tab, plugin settings<\/li>\n<li><strong>wc_deposits_settings_tabs_checkout_mode_tab<\/strong>\u00a0: this action could be used to output any extra fields in checkout-mode tab, plugin settings<\/li>\n<li><strong>wc_deposits_settings_tabs_second_payment_tab<\/strong>\u00a0: this action could be used to output any extra fields in second payment tab, plugin settings<\/li>\n<li><strong>wc_deposits_settings_tabs_gateways_tab<\/strong>\u00a0: this action could be used to output any extra fields in gateways tab, plugin settings<\/li>\n<\/ul>\n<\/li>\n<li><b>Filters<\/b>\n<ul>\n<li><strong>wc_deposits_cart_item_deposit_data\u00a0<\/strong>: this filter controls the total deposit amount for cart item,or it can be set to disable deposit for cart item if value returned is 0 . variable passed through this filter are $deposit_data , $cart_item<\/li>\n<li><strong>woocommerce_deposits_cart_deposit_amount\u00a0<\/strong>: this filter controls the total deposit amount for cart contents ,or it can be set to disable deposit for cart if value returned is 0. variables passed through this filter are $deposit_amount , $cart_total<\/li>\n<li><strong>wc_deposits_deposit_breakdown_tooltip_labels\u00a0<\/strong>: Labels included in deposit breakdown tooltip (if enabled ) variable passed through this filter is $labels ( array)<\/li>\n<li><strong>woocommerce_deposits_tooltip_html\u00a0<\/strong>: html of deposit breakdown tooltip (if enabled ) variable passed through this filter is $tooltip_html ( string)<\/li>\n<li><strong>woocommerce_deposits_tooltip_html\u00a0<\/strong>: html of deposit breakdown tooltip (if enabled ) variable passed through this filter is $tooltip_html ( string)<\/li>\n<li><strong>wc_deposits_product_enable_deposit\u00a0<\/strong>: controls whether deposit is enabled disabled for a product. variables passed through this filter are $enabled ( boolean) and $product_id<\/li>\n<li><strong>wc_deposits_product_force_deposit\u00a0<\/strong>: controls whether deposit is forced for a product. variables passed through this filter are $forced ( boolean) and $product_id<\/li>\n<li><strong>wc_deposits_product_deposit_amount\u00a0<\/strong>: controls deposit amount for a product. variables passed through this filter are $amount ( float) and $product_id<\/li>\n<li><strong>wc_deposits_product_deposit_amount_type\u00a0<\/strong>: controls deposit amount type for a product. variables passed through this filter are $amount_type ( string , valid values are \u201cfixed\u201d and \u201cpercent\u201d ) and $product_id<\/li>\n<li><strong>wc_deposits_partial_payment_name\u00a0<\/strong>: when an order is created with partial payments, during checkout the name of item is \u2018Partial Payment for order %s\u2019 (%s being the parent order ) , this filter allows changing the default value variables passed through this filter are $name (string) , $payment (array) and $order_id (integer)<\/li>\n<li><strong>wc_deposits_admin_partial_payment_actions\u00a0<\/strong>: controls the actions for a single payment in partial payments meta box, order editor. variables passed through this filter are $actions (array) , $payment (array) and $order_id (integer)<\/li>\n<li><strong>wc_deposits_settings_tabs\u00a0<\/strong>: controls the navigation tabs in plugin settings variable passed through this filter is $tabs (array)<\/li>\n<li><strong>wc_deposits_email_show_partial_payments_summary\u00a0<\/strong>: display or remove partial payments summary table in emails variables passed through this filter are $show (boolean) , $order(object), $email (object)<\/li>\n<li><strong>wc_deposits_myaccount_show_partial_payments_summary\u00a0<\/strong>: display or remove partial payments summary table in \u201cMy account\u201d page. variables passed through this filter are $show (boolean) , $order(object), $email (object)<\/li>\n<li><strong>wc_deposits_thankyou_show_partial_payments_summary\u00a0<\/strong>: display or remove partial payments summary table in \u201cOrder received \/ Thank you\u201d variables passed through this filter are $show (boolean) , $order(object), $email (object)<\/li>\n<li><strong>wc_deposits_partial_payment_title\u00a0<\/strong>: used to override the date \/ title displayed in partial payments table variables passed through this filter is $title (string) and $partial_payment(object)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Below is a full list of actions &amp; filters in our plugin Actions wc_deposits_enqueue_product_scripts\u00a0: this action is triggered when deposit buttons template is loaded on single product page wc_deposits_enqueue_deposit_button_scripts\u00a0: this action is triggered when deposit buttons template is loaded on checkout page when checkout mode is enabled wc_deposits_after_settings_tabs_content\u00a0: this action could be used to output [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[20],"tags":[],"class_list":["post-150","post","type-post","status-publish","format-standard","hentry","category-hooks-reference"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.6 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Hooks Reference - Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce<\/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.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Hooks Reference - Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce\" \/>\n<meta property=\"og:description\" content=\"Below is a full list of actions &amp; filters in our plugin Actions wc_deposits_enqueue_product_scripts\u00a0: this action is triggered when deposit buttons template is loaded on single product page wc_deposits_enqueue_deposit_button_scripts\u00a0: this action is triggered when deposit buttons template is loaded on checkout page when checkout mode is enabled wc_deposits_after_settings_tabs_content\u00a0: this action could be used to output [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/\" \/>\n<meta property=\"og:site_name\" content=\"Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce\" \/>\n<meta property=\"article:published_time\" content=\"2024-05-07T04:05:13+00:00\" \/>\n<meta name=\"author\" content=\"Admin\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Admin\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/\",\"url\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/\",\"name\":\"Hooks Reference - Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce\",\"isPartOf\":{\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#website\"},\"datePublished\":\"2024-05-07T04:05:13+00:00\",\"author\":{\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#\/schema\/person\/48ec32cabcfaa47d51d7a2dc7dbbb757\"},\"breadcrumb\":{\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Hooks Reference\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#website\",\"url\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/\",\"name\":\"Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#\/schema\/person\/48ec32cabcfaa47d51d7a2dc7dbbb757\",\"name\":\"Admin\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/fe30751c82fe675a4fa1dad833f3c9abdf1e1d3ca16908235512535383cd7383?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/fe30751c82fe675a4fa1dad833f3c9abdf1e1d3ca16908235512535383cd7383?s=96&d=mm&r=g\",\"caption\":\"Admin\"},\"sameAs\":[\"https:\/\/docs.mage-people.com\"],\"url\":\"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/author\/admin\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Hooks Reference - Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce","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.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/","og_locale":"en_US","og_type":"article","og_title":"Hooks Reference - Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce","og_description":"Below is a full list of actions &amp; filters in our plugin Actions wc_deposits_enqueue_product_scripts\u00a0: this action is triggered when deposit buttons template is loaded on single product page wc_deposits_enqueue_deposit_button_scripts\u00a0: this action is triggered when deposit buttons template is loaded on checkout page when checkout mode is enabled wc_deposits_after_settings_tabs_content\u00a0: this action could be used to output [&hellip;]","og_url":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/","og_site_name":"Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce","article_published_time":"2024-05-07T04:05:13+00:00","author":"Admin","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Admin","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/","url":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/","name":"Hooks Reference - Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce","isPartOf":{"@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#website"},"datePublished":"2024-05-07T04:05:13+00:00","author":{"@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#\/schema\/person\/48ec32cabcfaa47d51d7a2dc7dbbb757"},"breadcrumb":{"@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/hooks-reference\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/"},{"@type":"ListItem","position":2,"name":"Hooks Reference"}]},{"@type":"WebSite","@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#website","url":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/","name":"Documentation - Advanced Deposit &amp; Partial Payments for WooCommerce","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#\/schema\/person\/48ec32cabcfaa47d51d7a2dc7dbbb757","name":"Admin","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/fe30751c82fe675a4fa1dad833f3c9abdf1e1d3ca16908235512535383cd7383?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/fe30751c82fe675a4fa1dad833f3c9abdf1e1d3ca16908235512535383cd7383?s=96&d=mm&r=g","caption":"Admin"},"sameAs":["https:\/\/docs.mage-people.com"],"url":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/author\/admin\/"}]}},"_links":{"self":[{"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/posts\/150","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/comments?post=150"}],"version-history":[{"count":1,"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/posts\/150\/revisions"}],"predecessor-version":[{"id":151,"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/posts\/150\/revisions\/151"}],"wp:attachment":[{"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/media?parent=150"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/categories?post=150"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.mage-people.com\/advanced-partial-payment-or-deposit-for-woocommerce\/wp-json\/wp\/v2\/tags?post=150"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}