sion( $output_format ); // Filter filename $order_ids = isset( $args['order_ids'] ) ? $args['order_ids'] : array( $this->order_id ); $filename = apply_filters( 'wpo_wcpdf_filename', $filename, $this->get_type(), $order_ids, $context, $args ); // sanitize filename (after filters to prevent human errors)! return sanitize_file_name( $filename ); } /** * Initialise settings */ public function init_settings() { do_action( "wpo_wcpdf_before_{$this->type}_init_settings", $this ); foreach ( $this->output_formats as $output_format ) { $settings_fields = array(); switch ( $output_format ) { default: case 'pdf': $page = $option_group = $option_name = "wpo_wcpdf_documents_settings_{$this->get_type()}"; $settings_fields = apply_filters( "wpo_wcpdf_settings_fields_documents_{$this->get_type()}", $this->get_pdf_settings_fields( $option_name ), $page, $option_group, $option_name ); // legacy filter break; case 'ubl': $page = $option_group = $option_name = "wpo_wcpdf_documents_settings_{$this->get_type()}_{$output_format}"; $settings_fields = $this->get_ubl_settings_fields( $option_name ); break; } if ( ! empty( $settings_fields ) ) { // allow plugins to alter settings fields $settings_fields = apply_filters( "wpo_wcpdf_settings_fields_documents_{$this->type}_{$output_format}", $settings_fields, $page, $option_group, $option_name, $this ); WPO_WCPDF()->settings->add_settings_fields( $settings_fields, $page, $option_group, $option_name ); } } do_action( "wpo_wcpdf_after_{$this->type}_init_settings", $this ); } /** * PDF settings fields */ public function get_pdf_settings_fields( $option_name ) { $settings_fields = array( array( 'type' => 'section', 'id' => $this->type, 'title' => '', 'callback' => 'section', ), array( 'type' => 'setting', 'id' => 'enabled', 'title' => __( 'Enable', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'enabled', ) ), array( 'type' => 'setting', 'id' => 'attach_to_email_ids', 'title' => __( 'Attach to:', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'multiple_checkboxes', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'attach_to_email_ids', 'fields_callback' => array( $this, 'get_wc_emails' ), /* translators: directory path */ 'description' => !is_writable( WPO_WCPDF()->main->get_tmp_path( 'attachments' ) ) ? '' . sprintf( __( 'It looks like the temp folder (%s) is not writable, check the permissions for this folder! Without having write access to this folder, the plugin will not be able to email invoices.', 'woocommerce-pdf-invoices-packing-slips' ), WPO_WCPDF()->main->get_tmp_path( 'attachments' ) ).'':'', ) ), array( 'type' => 'setting', 'id' => 'disable_for_statuses', 'title' => __( 'Disable for:', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'disable_for_statuses', 'options_callback' => 'wc_get_order_statuses', 'multiple' => true, 'enhanced_select' => true, 'placeholder' => __( 'Select one or more statuses', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'display_shipping_address', 'title' => __( 'Display shipping address', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'display_shipping_address', 'options' => array( '' => __( 'No' , 'woocommerce-pdf-invoices-packing-slips' ), 'when_different'=> __( 'Only when different from billing address' , 'woocommerce-pdf-invoices-packing-slips' ), 'always' => __( 'Always' , 'woocommerce-pdf-invoices-packing-slips' ), ), // 'description' => __( 'Display shipping address (in addition to the default billing address) if different from billing address', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'display_email', 'title' => __( 'Display email address', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'display_email', ) ), array( 'type' => 'setting', 'id' => 'display_phone', 'title' => __( 'Display phone number', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'display_phone', ) ), array( 'type' => 'setting', 'id' => 'display_customer_notes', 'title' => __( 'Display customer notes', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'display_customer_notes', 'store_unchecked' => true, 'default' => 1, ) ), array( 'type' => 'setting', 'id' => 'display_date', 'title' => __( 'Display invoice date', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'display_date', 'options' => array( '' => __( 'No' , 'woocommerce-pdf-invoices-packing-slips' ), 'invoice_date' => __( 'Invoice Date' , 'woocommerce-pdf-invoices-packing-slips' ), 'order_date' => __( 'Order Date' , 'woocommerce-pdf-invoices-packing-slips' ), ), ) ), array( 'type' => 'setting', 'id' => 'due_date', 'title' => __( 'Display due date', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'due_date', 'options' => apply_filters( 'wpo_wcpdf_due_date_options', array( '' => __( 'No', 'woocommerce-pdf-invoices-packing-slips' ), '1' => __( '1 day', 'woocommerce-pdf-invoices-packing-slips' ), '7' => __( '7 days', 'woocommerce-pdf-invoices-packing-slips' ), '30' => __( '30 days', 'woocommerce-pdf-invoices-packing-slips' ), ), $this->type ), 'description' => __( 'Displays a due date below the order data.', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'display_number', 'title' => __( 'Display invoice number', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'display_number', 'options' => array( '' => __( 'No' , 'woocommerce-pdf-invoices-packing-slips' ), 'invoice_number' => __( 'Invoice Number' , 'woocommerce-pdf-invoices-packing-slips' ), 'order_number' => __( 'Order Number' , 'woocommerce-pdf-invoices-packing-slips' ), ), 'description' => sprintf( '%s %s %s', __( 'Warning!', 'woocommerce-pdf-invoices-packing-slips' ), __( 'Using the Order Number as invoice number is not recommended as this may lead to gaps in the invoice number sequence (even when order numbers are sequential).', 'woocommerce-pdf-invoices-packing-slips' ), __( 'More information', 'woocommerce-pdf-invoices-packing-slips' ) ), ) ), array( 'type' => 'setting', 'id' => 'next_invoice_number', 'title' => __( 'Next invoice number (without prefix/suffix etc.)', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'next_number_edit', 'section' => $this->type, 'args' => array( 'store_callback' => array( $this, 'get_sequential_number_store' ), 'size' => '10', 'description' => __( 'This is the number that will be used for the next document. By default, numbering starts from 1 and increases for every new document. Note that if you override this and set it lower than the current/highest number, this could create duplicate numbers!', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'number_format', 'title' => __( 'Number format', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'multiple_text_input', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'number_format', 'fields' => array( 'prefix' => array( 'label' => __( 'Prefix' , 'woocommerce-pdf-invoices-packing-slips' ), 'size' => 20, 'description' => __( 'If set, this value will be used as number prefix.' , 'woocommerce-pdf-invoices-packing-slips' ) . ' ' . sprintf( /* translators: 1. document type, 2-3 placeholders */ __( 'You can use the %1$s year and/or month with the %2$s or %3$s placeholders respectively.', 'woocommerce-pdf-invoices-packing-slips' ), __( 'invoice', 'woocommerce-pdf-invoices-packing-slips' ), '[invoice_year]', '[invoice_month]' ) . ' ' . __( 'Check the Docs article below to see all the available placeholders for prefix/suffix.', 'woocommerce-pdf-invoices-packing-slips' ), ), 'suffix' => array( 'label' => __( 'Suffix' , 'woocommerce-pdf-invoices-packing-slips' ), 'size' => 20, 'description' => __( 'If set, this value will be used as number suffix.' , 'woocommerce-pdf-invoices-packing-slips' ) . ' ' . sprintf( /* translators: 1. document type, 2-3 placeholders */ __( 'You can use the %1$s year and/or month with the %2$s or %3$s placeholders respectively.', 'woocommerce-pdf-invoices-packing-slips' ), __( 'invoice', 'woocommerce-pdf-invoices-packing-slips' ), '[invoice_year]', '[invoice_month]' ) . ' ' . __( 'Check the Docs article below to see all the available placeholders for prefix/suffix.', 'woocommerce-pdf-invoices-packing-slips' ), ), 'padding' => array( 'label' => __( 'Padding' , 'woocommerce-pdf-invoices-packing-slips' ), 'size' => 20, 'type' => 'number', /* translators: document type */ 'description' => sprintf( __( 'Enter the number of digits you want to use as padding. For instance, enter 6 to display the %s number 123 as 000123, filling it with zeros until the number set as padding is reached.' , 'woocommerce-pdf-invoices-packing-slips' ), __( 'invoice', 'woocommerce-pdf-invoices-packing-slips' ) ), ), ), /* translators: document type */ 'description' => __( 'For more information about setting up the number format and see the available placeholders for the prefix and suffix, check this article:', 'woocommerce-pdf-invoices-packing-slips' ) . sprintf( ' %s', __( 'Number format explained', 'woocommerce-pdf-invoices-packing-slips') ) . '.

'. sprintf( __( 'Note: Changes made to the number format will only be reflected on new orders. Also, if you have already created a custom %s number format with a filter, the above settings will be ignored.', 'woocommerce-pdf-invoices-packing-slips' ), __( 'invoice', 'woocommerce-pdf-invoices-packing-slips' ) ), ) ), array( 'type' => 'setting', 'id' => 'reset_number_yearly', 'title' => __( 'Reset invoice number yearly', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'reset_number_yearly', ) ), array( 'type' => 'setting', 'id' => 'log_number_generation', 'title' => __( 'Log invoice number generation', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'log_number_generation', 'description' => sprintf( /* translators: here link */ __( 'Enables the invoice number generation logs %s. Helpful for debugging numbering issues.', 'woocommerce-pdf-invoices-packing-slips' ), ''.__( 'here', 'woocommerce-pdf-invoices-packing-slips' ).'' ), ) ), array( 'type' => 'setting', 'id' => 'my_account_buttons', 'title' => __( 'Allow My Account invoice download', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'my_account_buttons', 'options' => array( 'available' => __( 'Only when an invoice is already created/emailed' , 'woocommerce-pdf-invoices-packing-slips' ), 'custom' => __( 'Only for specific order statuses (define below)' , 'woocommerce-pdf-invoices-packing-slips' ), 'always' => __( 'Always' , 'woocommerce-pdf-invoices-packing-slips' ), 'never' => __( 'Never' , 'woocommerce-pdf-invoices-packing-slips' ), ), 'custom' => array( 'type' => 'multiple_checkboxes', 'args' => array( 'option_name' => $option_name, 'id' => 'my_account_restrict', 'fields_callback' => array( $this, 'get_wc_order_status_list' ), ), ), ) ), array( 'type' => 'setting', 'id' => 'invoice_number_column', 'title' => __( 'Enable invoice number column in the orders list', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'invoice_number_column', ) ), array( 'type' => 'setting', 'id' => 'invoice_date_column', 'title' => __( 'Enable invoice date column in the orders list', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'invoice_date_column', ) ), array( 'type' => 'setting', 'id' => 'invoice_number_search', 'title' => __( 'Enable invoice number search in the orders list', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'invoice_number_search', 'description' => __( 'Can potentially slow down the search process.', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'disable_free', 'title' => __( 'Disable for free orders', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'disable_free', /* translators: zero number */ 'description' => sprintf(__( "Disable document when the order total is %s", 'woocommerce-pdf-invoices-packing-slips' ), function_exists('wc_price') ? wc_price( 0 ) : 0 ), ) ), array( 'type' => 'setting', 'id' => 'mark_printed', 'title' => __( 'Mark as printed', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'select', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'mark_printed', 'options' => array_merge( [ 'manually' => __( 'Manually', 'woocommerce-pdf-invoices-packing-slips' ), ], apply_filters( 'wpo_wcpdf_document_triggers', [ 'single' => __( 'On single order action', 'woocommerce-pdf-invoices-packing-slips' ), 'bulk' => __( 'On bulk order action', 'woocommerce-pdf-invoices-packing-slips' ), 'my_account' => __( 'On my account', 'woocommerce-pdf-invoices-packing-slips' ), 'email_attachment' => __( 'On email attachment', 'woocommerce-pdf-invoices-packing-slips' ), 'document_data' => __( 'On order document data (number and/or date set manually)', 'woocommerce-pdf-invoices-packing-slips' ), ] ) ), 'multiple' => true, 'enhanced_select' => true, 'description' => __( 'Allows you to mark the document as printed, manually (in the order page) or automatically (based on the document creation context you have selected).', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'unmark_printed', 'title' => __( 'Unmark as printed', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'unmark_printed', 'description' => __( 'Adds a link in the order page to allow to remove the printed mark.', 'woocommerce-pdf-invoices-packing-slips' ), ) ), array( 'type' => 'setting', 'id' => 'use_latest_settings', 'title' => __( 'Always use most current settings', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type, 'args' => array( 'option_name' => $option_name, 'id' => 'use_latest_settings', 'description' => __( "When enabled, the document will always reflect the most current settings (such as footer text, document name, etc.) rather than using historical settings.", 'woocommerce-pdf-invoices-packing-slips' ) . "
" . __( "Caution: enabling this will also mean that if you change your company name or address in the future, previously generated documents will also be affected.", 'woocommerce-pdf-invoices-packing-slips' ), ) ), ); // remove/rename some fields when invoice number is controlled externally if ( apply_filters( 'woocommerce_invoice_number_by_plugin', false ) ) { $remove_settings = array( 'next_invoice_number', 'number_format', 'reset_number_yearly' ); foreach ( $settings_fields as $key => $settings_field ) { if ( in_array( $settings_field['id'], $remove_settings ) ) { unset( $settings_fields[$key] ); } elseif ( $settings_field['id'] == 'display_number' ) { // alternate description for invoice number $invoice_number_desc = __( 'Invoice numbers are created by a third-party extension.', 'woocommerce-pdf-invoices-packing-slips' ); if ( $config_link = apply_filters( 'woocommerce_invoice_number_configuration_link', null ) ) { /* translators: link */ $invoice_number_desc .= ' '.sprintf(__( 'Configure it here.', 'woocommerce-pdf-invoices-packing-slips' ), esc_attr( $config_link ) ); } $settings_fields[$key]['args']['description'] = ''.$invoice_number_desc.''; } } } return apply_filters( "wpo_wcpdf_{$this->type}_pdf_settings_fields", $settings_fields, $option_name, $this ); } /** * UBL settings fields */ public function get_ubl_settings_fields( $option_name ) { $settings_fields = array( array( 'type' => 'section', 'id' => $this->type.'_ubl', 'title' => '', 'callback' => 'section', ), array( 'type' => 'setting', 'id' => 'enabled', 'title' => __( 'Enable', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type.'_ubl', 'args' => array( 'option_name' => $option_name, 'id' => 'enabled', ) ), array( 'type' => 'setting', 'id' => 'attach_to_email_ids', 'title' => __( 'Attach to:', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'multiple_checkboxes', 'section' => $this->type.'_ubl', 'args' => array( 'option_name' => $option_name, 'id' => 'attach_to_email_ids', 'fields_callback' => array( $this, 'get_wc_emails' ), /* translators: directory path */ 'description' => ! is_writable( WPO_WCPDF()->main->get_tmp_path( 'attachments' ) ) ? '' . sprintf( __( 'It looks like the temp folder (%s) is not writable, check the permissions for this folder! Without having write access to this folder, the plugin will not be able to email invoices.', 'woocommerce-pdf-invoices-packing-slips' ), WPO_WCPDF()->main->get_tmp_path( 'attachments' ) ).'':'', ) ), array( 'type' => 'setting', 'id' => 'include_encrypted_pdf', 'title' => __( 'Include encrypted PDF:', 'woocommerce-pdf-invoices-packing-slips' ), 'callback' => 'checkbox', 'section' => $this->type.'_ubl', 'args' => array( 'option_name' => $option_name, 'id' => 'include_encrypted_pdf', 'description' => __( 'Include the PDF Invoice file encrypted in the UBL file.', 'woocommerce-pdf-invoices-packing-slips' ), ) ), ); return apply_filters( "wpo_wcpdf_{$this->type}_ubl_settings_fields", $settings_fields, $option_name, $this ); } /** * Document number title */ public function get_number_title() { $number_title = __( 'Invoice Number:', 'woocommerce-pdf-invoices-packing-slips' ); return apply_filters( "wpo_wcpdf_{$this->slug}_number_title", $number_title, $this ); } /** * Document date title */ public function get_date_title() { $date_title = __( 'Invoice Date:', 'woocommerce-pdf-invoices-packing-slips' ); return apply_filters( "wpo_wcpdf_{$this->slug}_date_title", $date_title, $this ); } } endif; // class_exists