Development

templates/yith-pdf-invoice/invoice-totals.php

Filter the negative discount symbol in the invoice totals

 Params  string the symbol. 

 
Return  string 

---

Filter the condition show the total tax section in the invoice totals

 Params  bool true to show it, false to not. 

 
Return  bool 

---

templates/yith-pdf-invoice/invoice-details.php

Filter the condition to hide the bundled items in the invoice

 Params  bool true to hide them, false to not. 

 
Return  bool 

---

Filter the condition to calculate the taxes with legacy method

 Params  bool true to use the legacy calculation, false to not. 

 
Return  bool 

---

Filter the condition show the fees section in the invoice

 Params  bool true to show it, false to not.  object $document the document object. 

 
Return  bool 

---

Filter the condition show the shipping section in the invoice

 Params  bool true to show it, false to not.  object $document the document object. 

 
Return  bool 

---

templates/yith-pdf-invoice/document-notes.php

Filter the document notes data

 Params  string the document notes.  object $document the document object. 

 
Return  string 

---

templates/yith-pdf-invoice/document-data-invoice.php

Filter the invoice number label

 Params  string the label.  object $document the document object. 

 
Return  string 

---

Filter the invoice amount label

 Params  string the label. 

 
Return  string 

---

templates/yith-pdf-invoice/document-data-credit-note.php

Filter the credit note number label

 Params  string the label.  object $document the document object. 

 
Return  string 

---

Filter the date displayed in the document data

 Params  string the date.  object $document the document object. 

 
Return  string 

---

Filter the condition to display the order amount in the document data

 Params  bool true to display it, false to not. 

 
Return  bool 

---

templates/yith-pdf-invoice/credit-note-details-with-products.php

Filter the product image path in the document

 Params  string $image_path the product image path.  object $_product the product object. 

 
Return  string 

---

templates/yith-pdf-invoice/xml/electronic-invoice-ita/datipagamento.php

Filter the electronic invoice fields value

 Params  string the value.  string field ID.  object $document the document object. 

 
Return  string 

---

templates/yith-pdf-invoice/pdf-builder/product-totals.php

Filter the negative discount symbol in the invoice totals

 Params    string the symbol. 

 
Return  string 

---

templates/yith-pdf-invoice/pdf-builder/product-table.php

Filter the condition to calculate the taxes with legacy method

 Params    bool true to use the legacy calculation, false to not. 

 
Return  bool 

---

Filter the condition show the fees section in the invoice

 Params    bool $show_fee_items True to show it, false to not.    object  $resource  the document object. 

 
Return  bool 

---

Filter the condition show the shipping section in the invoice

 Params    bool $show_shipping True to show it, false to not.    object  $resource  The document object. 

 
Return  bool 

---

templates/yith-pdf-invoice/black_white_template/document-logo.php

Filter the path of the company image in the documents

 Params  string $company_logo_path the company logo path. 

 
Return  string 

---

includes/functions-yith-ywpi.php

Filter the customer details allowed HTML tags

 Params  string the allowed HTML tags. 

 
Return  string 

---

Filter the customer details content

 Params  string $content the customer details content.  object $document the document object. 

 
Return  string 

---

includes/class.yith-ywpi-plugin-fw-loader.php

Filter the settings panel capability

 Params  string the capability. Default: manage_options. 

 
Return  string 

---

includes/class.yith-ywpi-multivendor-loader.php

Filter the condition to display the parent order number in the document

 Params  bool true to display it, false to not.  object $document the document object. 

 
Return  bool 

---

Filter the admin as vendor title in My account

 Params  string the title. 

 
Return  string 

---

includes/class.yith-ywpi-list-tables.php

Filter the columns to export in the CSV

 Params  array the columns. 

 
Return  array 

---

Filter the default column output when exporting in CSV

 Params  string the default output.  int $key the key.  object $order the order object. 

 
Return  string 

---

Filter the condition to download all files in a zip

 Params  bool false to include the order invoice in the zip, true to not.  object $order the order object. 

 
Return  bool 

---

includes/class.yith-ywpi-backend.php

Filter the condition to show the invoice metabox in the order edit page

 Params  bool true to display it, false to not.  object $post the $post object. 

 
Return  bool 

---

Filter the condition to display the option to create the invoice for the current order

 Params  bool true to create it, false to not.  int the order ID.  string the document type. 

 
Return  bool 

---

Filter the invoice buttons in the order list table

 Params  string $invoice_section the invoice buttons.  object $order the order object. 

 
Return  string 

---

Filter the packing slip buttons in the order list table

 Params  string $html the packing slip buttons.  object $order the order object. 

 
Return  string 

---

Filter the condition to show the invoice status in the order list table

 Params  bool false to display it, true to not. 

 
Return  bool 

---

Filter the "Invoice number" label in the invoice metabox on the order edit page

 Params  string the label. 

 
Return  string 

---

Filter the "Receipt" label in the invoice metabox on the order edit page

 Params  string the label. 

 
Return  string 

---

Filter the condition to show the invoice button in the order page

 Params  bool true to show it, false to not.  object $order the order object. 

 
Return  string 

---

Filter the condition to show the packing slip button in the order page

 Params  bool true to show it, false to not.  object $order the order object. 

 
Return  string 

---

Filter the condition to show the proforma button in the order page

 Params  bool true to show it, false to not.  object $order the order object. 

 
Return  string 

---

includes/class.yith-woocommerce-pdf-invoice.php

Filter the admin admin JS script localize

 Params  array the localize data. 

 
Return  array 

---

Filter the condition to force the enqueue of the frontend styles

 Params  bool true to force the load, false to not. 

 
Return  bool 

---

Filter the condition to force the enqueue of the frontend scripts

 Params  bool true to force the load, false to not. 

 
Return  bool 

---

Filter the condition to set as visible the document notes

 Params  bool true to set as visible, false to not.  object $document the document object. 

 
Return  bool 

---

Filter the document notes

 Params  string the document notes.  object $document the document object. 

 
Return  string 

---

Filter the condition to set as visible the document footer

 Params  bool true to set as visible, false to not.  object $document the document object. 

 
Return  bool 

---

Filter the document titel

 Params  string the document title.  object $document the document object. 

 
Return  string 

---

Filter the automatic proforma creation

 Params  bool true to create them automatically, false to not.  int $order_id the orderd ID. 

 
Return  bool 

---

Filter the automatic invoice creation

 Params  bool true to create them automatically, false to not.  int $order_id the orderd ID. 

 
Return  bool 

---

Filter the automatic packing slip creation

 Params  bool true to create them automatically, false to not.  int $order_id the orderd ID. 

 
Return  bool 

---

Filter the automatic credit note creation

 Params  bool true to create them automatically, false to not. 

 
Return  bool 

---

Filter the condition to attach the credit notes to the emails

 Params  bool true to attach them, false to not. 

 
Return  bool 

---

Filter the order status where we want to attach the invoices to the emails

 Params  array $allowed_statuses the allowed statuses. 

 
Return  array 

---

Filter the order status where we want to attach the credit notes to the emails

 Params  array $allowed_statuses the allowed statuses. 

 
Return  array 

---

Filter the invoice information URL

 Params  string the invoice information URL.  object $order the order object. 

 
Return  string 

---

Filter the condition to skip the document generation in an order

 Params  bool true to skip, false to not.  int $order_id the order ID.  string the document type.  string the document extension. 

 
Return  bool 

---

Filter the document date

 Params  string the document date.  object $document the document object. 

 
Return  string 

---

Filter the formatted invoice number

 Params  string $replace_placeholders the invoice number with placeholders.  string $formatted_number the formatted invoice number.  object $document the document object. 

 
Return  string 

---

Filter the invoice number used when it's reset at the year start

 Params  int the invoice number to reset. 

 
Return  int 

---

Filter the credit note number used when it's reset at the year start

 Params  int the credit note number to reset. 

 
Return  int 

---

Filter the current invoice number

 Params  int $current_invoice_number the current invoice number.  object the order object.  object $document the document object. 

 
Return  int 

---

Filter the file content type

 Params  string the file content type.  string $document the file content.  string $extension the file extension. 

 
Return  string 

---

 Params  array array with the capabilities.  int $order_id the order ID.  string $document_type the document type. 

 
Return  string 

---

Filter the replace of the customer details

 Params  string $replace_value the values replaced.  string $match the value to check.  int $order_id the order ID. 

 
Return  string 

---

Filter the customer replace details in the invoice

 Params  string $replace_details the replace details. 

 
Return  string 

---

Filter the customer details pattern in the invoice

 Params  string $replace_details the replace details. 

 
Return  string 

---

Filter the path of the folder to store the documents

 Params  string $folder_path the folder path.  object $document the document object.  string $extension the document extension. 

 
Return  string 

---

Filter to change filename format of invoice or credit note document. Use placeholder [number] to get automatically order of invoice or credit note

 Params  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter to change filename format of proforma document. Use placeholder [order_number] to get order number

 Params  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter to the proforma filename

 Params  string the filename.  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter to change filename format of packing slip document. Use placeholder [order_number] to get order number

 Params  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter to the packing slip filename

 Params  string the filename.  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter to the receipt slip filename

 Params  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter the document pattern

 Params  string $pattern the pattern.  object $document the document object. 

 
Return  string 

---

Filter the condition to sanitize the document pattern

 Params  bool true to sanitize, false to not. 

 
Return  bool 

---

Filter the body class of the invoice template

 Params  string $main_class the main class. 

 
Return  string 

---

Filter the document HTML before rendeing

 Params  string $html the HTML.  object $document the document object. 

 
Return  string 

---

Filter the arguments passed to MPDF to construct the PDF

 Params  array the arguments. 

 
Return  array 

---

Filter the PDF directionality

 Params  string $direction the directionality. Default: ltr 

 
Return  string 

---

Filter the style before the PDF creation

 Params  string $style the style.  string $template_selected the selected template.  object $document the document object. 

 
Return  string 

---

includes/class.yith-woocommerce-pdf-invoice-premium.php

Filter the display of the gift card total applied to the order

 Params  string $res the gift card total section.  string $gift_card_total the gift card total value.  object $order the order object. 

 
Return  string 

---

Filter the condition to allow the Dropbox sync

 Params  bool true to allow, false to not.  object $document the document object. 

 
Return  bool 

---

Filter the Proforma document title

 Params  string the title. 

 
Return  string 

---

Filter the Credit Note document title

 Params  string the title. 

 
Return  string 

---

Filter the Receipt document title

 Params  string the title. 

 
Return  string 

---

Filter the condition to show the invoice button in the order on My account

 Params  bool true to display it, false to not. 

 
Return  bool 

---

Filter the "Invoice" button name in My account

 Params  string the button name. 

 
Return  string 

---

Filter the condition to show the pro forma button in the order on My account

 Params  bool true to display it, false to not.  object $order the order object. 

 
Return  bool 

---

Filter the "Proforma" button name in My account

 Params  string the button name. 

 
Return  string 

---

Filter the "Credit Note" button name in My account

 Params  string the button name. 

 
Return  string 

---

Filter the order actions in My account

 Params  array $actions the actions array.  object $order the order object. 

 
Return  array 

---

Filter the emails ID where we want to attach the proforma invoice

 Params  array the email ids to attach the proforma.  int $order_id the order ID. 

 
Return  array 

---

includes/class.yith-pdf-invoice-dropbox.php

Filter the DropBox folder to save the documents

 Params  string folder name.  object $document the document object. 

 
Return  string 

---

includes/class.yith-invoice-details.php

Filter the URL of the product image to display in the invoice

 Params  string the URL of the product image.  array $item the product item. 

 
Return  string 

---

Filter the default placeholder of the product image to display in the invoice

 Params  string the URL of the product image default palceholder.  array $item the product item. 

 
Return  string 

---

Filter the "SKU:" label in the product information on invoice

 Params  string the label.  array $item the product item. 

 
Return  string 

---

Filters the order item metadata to be displayed in the invoice

 Params  array                $metadata        Order item metadata  int                  $item_id         Order item ID  WC_Product           $_product        Product object  YITH_Invoice_Details $invoice_details Invoice details object 

 
Return  array 

---

Filter the product variation string in the product details

 Params  string the variation data.  array $meta the product meta data.  object $_product the product object. 

 
Return  string 

---

Filter the product regular price when null in the invoice details

 Params  string $product_regular_price_post_meta the product regular price.  array $item the product item. 

 
Return  string 

---

Filter the product price per unit

 Params  string $price the product price.  array $item the product item.  string $tax_aux the product price tax. 

 
Return  string 

---

Filter the product price per unit sale

 Params  string $price the product price.  array $item the product item.  string $tax_aux the product price tax. 

 
Return  string 

---

Filter the discount per item

 Params  string the discount.  array $item the product item. 

 
Return  string 

---

Filter the order subtotal in the invoice

 Params  string the order subtotal.  string $order_fee_amount the order fee amount.  object the order object. 

 
Return  string 

---

Filter the invoice subtotal

 Params  string $_order_subtotal the order subtotal.  object the order object.  string the product total discount.  string $order_fee_amount the order fee amount. 

 
Return  string 

---

Filter the invoice total discount

 Params  string the total discount.  object the order object.  string the product total discount. 

 
Return  string 

---

Filter the order currency in the invoice

 Params  string $currencythe the invoice currency.  string $order_currency the order currency.  object the order object. 

 
Return  string 

---

Filter the product short description when null, using the post meta

 Params  string $product_short_description_post_meta the prpduct short desciption.  array the product item. 

 
Return  string 

---

includes/class.yith-electronic-invoice.php

Filter the ID of the billing VAT field

 Params  string $field_id Field ID 

 
Return  string 

---

Filter the next progessive file ID

 Params  int the next progressive file ID.  int the actual file ID. 

 
Return  int 

---

Filter the electronic invoice filename

 Params  string the file name.  int $next_progressive_file_id the next actual file ID. 

 
Return  int 

---

Filter the condition to show the "Receiver ID" field at checkout for the electronic invoices

 Params  bool true to show it, false to not. 

 
Return  bool 

---

Filter the condition to show the "PEC" field at checkout for the electronic invoices

 Params  bool true to show it, false to not. 

 
Return  bool 

---

Filter the condition to hide the option to create the electronic invoice in the order edit page

 Params  bool true to hide it, false to not. 

 
Return  bool 

---

Filter the condition to validate the checkout fields

 Params  bool true to validate, false to not. 

 
Return  bool 

---

Filter the order item name for the XML file

 Params  string the item name.  array the item. 

 
Return  string 

---

Filter the encode text return for the electronic invoice

 Params  string $final_textthe the encoded text.  string $text the original text. 

 
Return  string 

---

Filter the order items to show in the invoice

 Params  array the order items.  object the order object. 

 
Return  array 

---

Filter the order fee to show in the invoice

 Params  array the order fee.  object the order object. 

 
Return  array 

---

Filter the order shipping to show in the invoice

 Params  array the order shipping.  object the order object. 

 
Return  array 

---

Filter the invoice formatted number

 Params  string the formatted number.  object $document the document object. 

 
Return  string 

---

Filter the checkout "(optional)" label.

 Params string the label. 

 
Return string. 

---

Filter the condition to set the receipt SSN as mandatory.

 Params bool True to set it as mandatory, false to not. 

 
Return bool. 

---

Filter the SSN error message.

 Params string the message. 

 
Return string. 

---

Filter the "Codice fiscale" lenght error message.

 Params string the message. 

 
Return string. 

---

Filter the "Codice fiscale" invalid characters error message.

 Params string the message. 

 
Return string. 

---

Filter the "Codice fiscale" digits and letters error message.

 Params string the message. 

 
Return string. 

---

Filter the wrong "Codice fiscale" error message.

 Params string the message. 

 
Return string. 

---

Filter the "Customer type" label at checkout for italian customers.

 Params string the label. 

 
Return string. 

---

Filter the "private" option label in the "Customer type" option for italian customers.

 Params string the label. 

 
Return string. 

---

Filter the "freelance" option label in the "Customer type" option for italian customers.

 Params string the label. 

 
Return string. 

---

Filter the "company" option label in the "Customer type" option for italian customers.

 Params string the label. 

 
Return string. 

---

includes/class.yith-checkout-addon.php

Filter the condition to ask the SSN as required

 Params  bool True to set it as require, false to not. 

 
Return  bool 

---

Filter the SSN field placeholder

 Params  string the placeholder. 

 
Return  string 

---

Filter the condition to ask the VAT as required

 Params  bool True to set it as require, false to not. 

 
Return  bool 

---

Filter the VAT field placeholder

 Params  string the placeholder. 

 
Return  string 

---

Filter the "Invoice type" label in the checkout.

 Params string the label.  

 
Return string. 

---

Filter the "Invoice" label in the invoice type selector at checkout.

 Params string the label.  

 
Return string. 

---

Filter the "Receipt" label in the invoice type selector at checkout.

 Params string the label.  

 
Return string. 

---

Filter the default value in the invoice type selector at checkout.

 Params string the default value. Default: "invoice".  

 
Return string. 

---

includes/templates/class.yith-ywpi-template.php

Filter the document title

 Params  string $document_title the title.  object $document the document object. 

 
Return  string 

---

Filter the condition to show the company details

 Params  bool False to display the company details, true to not. Default: false.  object $document the document object. 

 
Return  bool 

---

Filter the document company details

 Params  string $company_details the company details.  object $document the document object. 

 
Return  string 

---

includes/templates/class.yith-ywpi-template-default.php

Filter the condition to show the totals in the documents

 Params  bool True to display the totals, false to not. Default: true.  object $document the document object. 

 
Return  bool 

---

Filter the customer details content

 Params  string $full_content The formatted content of the customer details.  string $content The content of the customer details.  object $document the document object. 

 
Return  string 

---

includes/templates/class.yith-ywpi-black-white-template.php

Filter the company logo path displayed in the documents

 Params  string $company_logo_path the logo path.  object $document the document object. 

 
Return  string 

---

includes/pdf-builder/editor/class-yith-ywpi-pdf-template-editor.php

 Params    YITH_Document  $document  Document. 

 
Return  string 

---

includes/documents/class-yith-invoice.php

Filter the invoice document formatted date

 Params  string $date_to_convert the date converted.  string $format the date format.  object $order the order object. 

 
Return  string 

---

includes/documents/class-yith-document.php

Filter the document save path

 Params  string the save path.  string $extension the file extension.  int $order_id the order ID.  object the class object.. 

 
Return  string 

---

includes/documents/class-yith-credit-note.php

Filter the invoice date format

 Params  string the date format. 

 
Return  string 

---

includes/admin/class-yith-ywpi-documents-list-table.php

Filter the VAT field name

 Params  string the VAT field name. 

 
Return  string 

---

Filter the SSN field name

 Params  string the SSN field name. 

 
Return  string 

---

Filter the date format for the datepickers when displaying documents in the table

 Params  string the date format. 

 
Return  string 

---

includes/admin/class-yith-ywpi-credit-notes-list-table.php

Filter the Credit Notes table columns

 Params  array $columns the columns. 

 
Return  array 

---

Filter the number of documents to show per page

 Params  int the number of documents to show. 

 
Return  int 

---

Filter the date format converted from the datepickers when displaying documents in the table

 Params  string the date format. 

 
Return  string 

---