Hooks

This reference is generated during every documentation build directly from the hook file produced by Woo Batches. Search by hook name, description, or parameter, and filter the list by hook type.

Note: Hooks are intended for custom development. We cannot analyze customizations outside a commissioned development scope through regular product support.

178hooks

39Actions

139Filters

Data updated: Jul 10, 2025, 10:50 PM UTC

Search hooks

178 hooks

filterwoo_batches_admin_{page}_tabs_arrayWoo Batches

This filter filters the admin page tabs array

                  apply_filters( 'woo_batches_admin_{page}_tabs_array', array $page_tabs_array );
                

Copy signature

Parameters

$page_tabs_arrayarray

Includes the page tabs array

Since: 1.5.2

Sources:

• class-woo-batches-admin-page-actions.php:50

filterwoo_batches_admin_additional_screen_idsWoo Batches

This filter filters the admin additional screen IDS

                  apply_filters( 'woo_batches_admin_additional_screen_ids', array $additional_screen_ids );
                

Copy signature

Parameters

$additional_screen_idsarray

Includes all additional screen IDs

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:100

actionwoo_batches_admin_after_batches_details_email_tableWoo Batches

This hook fires after the batches details email table

                  do_action( 'woo_batches_admin_after_batches_details_email_table', Woo_Batches_Data_Store_Batch_Model[] $batches, bool $plain_text );
                

Copy signature

Parameters

$batchesWoo_Batches_Data_Store_Batch_Model[]

Includes all batches

$plain_textbool

If plain text or not

Since: 1.5.2

Sources:

• batches-details.php:82
• batches-details.php:51

actionwoo_batches_admin_after_page_action_{page}Woo Batches

This hook fires after an admin page action

                  do_action( 'woo_batches_admin_after_page_action_{page}' );
                

Copy signature

Since: 1.2.2

Sources:

• class-woo-batches-admin-page-actions.php:79

actionwoo_batches_admin_after_settings_{current_tab}Woo Batches

This hook fires after the settings output

                  do_action( 'woo_batches_admin_after_settings_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• settings.php:115

filterwoo_batches_admin_ajax_process_product_search_resultWoo Batches

This filter filters the admin AJAX process product search result

                  apply_filters( 'woo_batches_admin_ajax_process_product_search_result', array $product_result, WC_Product|bool|null $product );
                

Copy signature

Parameters

$product_resultarray

Includes a product search result (ID and text)

$productWC_Product|bool|null

The product object

Since: 1.8.0

Sources:

• class-woo-batches-admin-ajax.php:533

filterwoo_batches_admin_ajax_validate_batch_numbersWoo Batches

This filter filters the admin AJAX validate batch numbers

                  apply_filters( 'woo_batches_admin_ajax_validate_batch_numbers', array $batch_number_duplicates, array $batches );
                

Copy signature

Parameters

$batch_number_duplicatesarray

Includes already existing batch numbers

$batchesarray

Includes all checked batches

Since: 1.5.2

Sources:

• class-woo-batches-admin-ajax.php:502

filterwoo_batches_admin_batch_add_form_methodWoo Batches

This filter filters the admin batch add form method

                  apply_filters( 'woo_batches_admin_batch_add_form_method', string $batch_add_form_method );
                

Copy signature

Parameters

$batch_add_form_methodstring

The form method for the batch add form

Since: 1.8.0

Sources:

• add.php:15

filterwoo_batches_admin_batches_create_batch_dataWoo Batches

This filter filters the admin batch create batch data

                  apply_filters( 'woo_batches_admin_batches_create_batch_data', array $batch_data, array $post );
                

Copy signature

Parameters

$batch_dataarray

Includes all batch data

$postarray

Includes all variables passed to the current script via the HTTP POST method

Since: 1.8.0

Sources:

• class-woo-batches-admin-batches.php:202

filterwoo_batches_admin_batches_get_create_batch_urlWoo Batches

This filter filters the admin batches create batch URL

                  apply_filters( 'woo_batches_admin_batches_get_create_batch_url', string $create_batch_url );
                

Copy signature

Parameters

$create_batch_urlstring

The create batch URL

Since: 1.8.0

Sources:

• class-woo-batches-admin-batches.php:310

filterwoo_batches_admin_batches_list_table_classesWoo Batches

This filter filters the admin batches list table classes

                  apply_filters( 'woo_batches_admin_batches_list_table_classes', array $table_classes );
                

Copy signature

Parameters

$table_classesarray

Includes all table classes

Since: 1.5.2

Sources:

• class-woo-batches-admin-batches-list-table.php:206

filterwoo_batches_admin_batches_list_table_no_itemsWoo Batches

This filter filters the admin batches list table no items message

                  apply_filters( 'woo_batches_admin_batches_list_table_no_items', string $message );
                

Copy signature

Parameters

$messagestring

The no items message

Since: 1.5.2

Sources:

• class-woo-batches-admin-batches-list-table.php:432

filterwoo_batches_admin_batches_list_table_process_sortingWoo Batches

This filter filters the admin batches list table process sorting

                  apply_filters( 'woo_batches_admin_batches_list_table_process_sorting', array $batches );
                

Copy signature

Parameters

$batchesarray

Includes all batches

Since: 1.5.2

Sources:

• class-woo-batches-admin-batches-list-table.php:531

filterwoo_batches_admin_batches_list_table_sortable_columnsWoo Batches

This filter filters the admin batches list table sortable columns

                  apply_filters( 'woo_batches_admin_batches_list_table_sortable_columns', array $valid_sortable_columns );
                

Copy signature

Parameters

$valid_sortable_columnsarray

Includes all valid sortable columns

Since: 1.5.2

Sources:

• class-woo-batches-admin-batches-list-table.php:493

filterwoo_batches_admin_batches_page_titleWoo Batches

This filter filters the admin batches page title

                  apply_filters( 'woo_batches_admin_batches_page_title', string $title );
                

Copy signature

Parameters

$titlestring

The title

Since: 1.8.0

Sources:

• batches.php:13

filterwoo_batches_admin_batches_page_title_actionsWoo Batches

This filter filters the admin batches page title actions

                  apply_filters( 'woo_batches_admin_batches_page_title_actions', array $page_title_actions );
                

Copy signature

Parameters

$page_title_actionsarray

Includes the page title actions

Since: 1.8.0

Sources:

• batches.php:25

filterwoo_batches_admin_batches_views_arrayWoo Batches

This filter filters the admin batches views

                  apply_filters( 'woo_batches_admin_batches_views_array', array $batches_views );
                

Copy signature

Parameters

$batches_viewsarray

Includes the batches views

Since: 1.8.0

Sources:

• class-woo-batches-admin.php:395

actionwoo_batches_admin_before_batches_details_email_tableWoo Batches

This hook fires before the batches details email table

                  do_action( 'woo_batches_admin_before_batches_details_email_table', Woo_Batches_Data_Store_Batch_Model[] $batches, bool $plain_text );
                

Copy signature

Parameters

$batchesWoo_Batches_Data_Store_Batch_Model[]

Includes all batches

$plain_textbool

If plain text or not

Since: 1.5.2

Sources:

• batches-details.php:31
• batches-details.php:29

actionwoo_batches_admin_before_page_action_{page}Woo Batches

This hook fires before an admin page action

                  do_action( 'woo_batches_admin_before_page_action_{page}' );
                

Copy signature

Since: 1.2.2

Sources:

• class-woo-batches-admin-page-actions.php:58

actionwoo_batches_admin_before_settings_{current_tab}Woo Batches

This hook fires before the settings output

                  do_action( 'woo_batches_admin_before_settings_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• settings.php:55

actionwoo_batches_admin_before_status_{current_tab}Woo Batches

This hook fires before the status output

                  do_action( 'woo_batches_admin_before_status_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• statuses.php:34

filterwoo_batches_admin_filter_admin_body_classWoo Batches

This filter filters the admin body classes

                  apply_filters( 'woo_batches_admin_filter_admin_body_class', string $admin_body_classes );
                

Copy signature

Parameters

$admin_body_classesstring

The admin body classes

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:157

filterwoo_batches_admin_general_settingsWoo Batches

This filter filters the general settings

                  apply_filters( 'woo_batches_admin_general_settings', array $general_settings );
                

Copy signature

Parameters

$general_settingsarray

Includes the general settings

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-general.php:69

filterwoo_batches_admin_get_header_actionsWoo Batches

This filter filters the admin header actions

                  apply_filters( 'woo_batches_admin_get_header_actions', array $header_actions );
                

Copy signature

Parameters

$header_actionsarray

Includes all header actions

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:350

filterwoo_batches_admin_get_settings_{id}Woo Batches

This filter filters the settings for a setting page

                  apply_filters( 'woo_batches_admin_get_settings_{id}', array $settings, string $current_section );
                

Copy signature

Parameters

$settingsarray

Includes all settings

$current_sectionstring

The current settings section

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-page.php:99
• class-woo-batches-admin-settings-general.php:201
• class-woo-batches-admin-settings-orders.php:100
• class-woo-batches-admin-settings-products.php:119

filterwoo_batches_admin_get_settings_sections_{id}Woo Batches

This filter filters the settings sections for a settings page

                  apply_filters( 'woo_batches_admin_get_settings_sections_{id}', array $sections );
                

Copy signature

Parameters

$sectionsarray

Includes all sections

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-page.php:116

filterwoo_batches_admin_get_status_page_{id}Woo Batches

This filter filters the current admin status page ID

                  apply_filters( 'woo_batches_admin_get_status_page_{id}', string $id );
                

Copy signature

Parameters

$idstring

The page ID

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-page.php:94

filterwoo_batches_admin_get_woo_batches_navigation_breadcrumbsWoo Batches

This filter filters the admin navigation breadcrumbs

                  apply_filters( 'woo_batches_admin_get_woo_batches_navigation_breadcrumbs', array $breadcrumbs );
                

Copy signature

Parameters

$breadcrumbsarray

Includes all breadcrumbs

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:296

filterwoo_batches_admin_get_woo_batches_pagesWoo Batches

This filter filters all pages

                  apply_filters( 'woo_batches_admin_get_woo_batches_pages', array $pages );
                

Copy signature

Parameters

$pagesarray

Includes all pages

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:382

filterwoo_batches_admin_navigation_breadcrumb_admin_page_titleWoo Batches

This filter filters the admin navigation breadcrumb admin page title

                  apply_filters( 'woo_batches_admin_navigation_breadcrumb_admin_page_title', string $page_title, string $screen_id );
                

Copy signature

Parameters

$page_titlestring

The page title

$screen_idstring

The screen ID

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:280

filterwoo_batches_admin_navigation_breadcrumb_extension_displayed_tabWoo Batches

This filter filters the admin navigation breadcrumb extension displayed tab

                  apply_filters( 'woo_batches_admin_navigation_breadcrumb_extension_displayed_tab', string $displayed_tab, string $page_id, array $page_data );
                

Copy signature

Parameters

$displayed_tabstring

The displayed tab

$page_idstring

The page ID

$page_dataarray

Includes all page data

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:245

filterwoo_batches_admin_navigation_breadcrumb_extension_viewWoo Batches

This filter filters the admin navigation breadcrumb extension view

                  apply_filters( 'woo_batches_admin_navigation_breadcrumb_extension_view', string $view, string $page_id, array $page_data );
                

Copy signature

Parameters

$viewstring

The view

$page_idstring

The page ID

$page_dataarray

Includes all page data

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:258

filterwoo_batches_admin_navigation_breadcrumb_page_data_titleWoo Batches

This filter filters the admin navigation breadcrumb page data tile

                  apply_filters( 'woo_batches_admin_navigation_breadcrumb_page_data_title', string $title, string $page_id );
                

Copy signature

Parameters

$titlestring

The page data title

$page_idstring

The page ID

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:211

filterwoo_batches_admin_navigation_breadcrumbsWoo Batches

This filter filters all plugin admin navigation breadcrumbs

                  apply_filters( 'woo_batches_admin_navigation_breadcrumbs', array $breadcrumbs );
                

Copy signature

Parameters

$breadcrumbsarray

Includes navigation breadcrumbs

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:190

filterwoo_batches_admin_order_settingsWoo Batches

This filter filters the order settings

                  apply_filters( 'woo_batches_admin_order_settings', array $order_settings );
                

Copy signature

Parameters

$order_settingsarray

Includes the order settings

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-orders.php:67

actionwoo_batches_admin_page_action_{page}Woo Batches

This hook fires the admin page action

                  do_action( 'woo_batches_admin_page_action_{page}' );
                

Copy signature

Since: 1.2.2

Sources:

• class-woo-batches-admin-page-actions.php:71

filterwoo_batches_admin_page_actions_is_woo_batches_pageWoo Batches

This filter filters if its a plugin page or not

                  apply_filters( 'woo_batches_admin_page_actions_is_woo_batches_page', bool $is_woo_batches_page );
                

Copy signature

Parameters

$is_woo_batches_pagebool

If its a plugin page or not

Since: 1.5.2

Sources:

• class-woo-batches-admin-page-actions.php:107

filterwoo_batches_admin_product_settingsWoo Batches

This filter filters the product settings

                  apply_filters( 'woo_batches_admin_product_settings', array $product_settings );
                

Copy signature

Parameters

$product_settingsarray

Includes the product settings

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-products.php:69

filterwoo_batches_admin_screen_idsWoo Batches

This filter filters the admin screen IDS

                  apply_filters( 'woo_batches_admin_screen_ids', array $screen_ids, string $woo_batches_screen_id );
                

Copy signature

Parameters

$screen_idsarray

Includes all screen IDs

$woo_batches_screen_idstring

Default plugin screen ID

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:75

actionwoo_batches_admin_settings_{current_tab}Woo Batches

This hook fires during the settings content output

                  do_action( 'woo_batches_admin_settings_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• settings.php:100

actionwoo_batches_admin_settings_{id}Woo Batches

This hook fires when a setting gets outputted

                  do_action( 'woo_batches_admin_settings_{id}' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:643

actionwoo_batches_admin_settings_{id}_afterWoo Batches

This hook fires after a section was outputted

                  do_action( 'woo_batches_admin_settings_{id}_after' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:672

actionwoo_batches_admin_settings_{id}_endWoo Batches

This hook fires when a section end gets outputted

                  do_action( 'woo_batches_admin_settings_{id}_end' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:660

actionwoo_batches_admin_settings_after_output_action_{id}Woo Batches

This hook fires after the settings output action

                  do_action( 'woo_batches_admin_settings_after_output_action_{id}', array $settings, string $current_section );
                

Copy signature

Parameters

$settingsarray

Includes all settings

$current_sectionstring

The current settings section

Since: 1.5.0

Sources:

• class-woo-batches-admin-settings-page.php:183

actionwoo_batches_admin_settings_before_output_action_{id}Woo Batches

This hook fires before the settings output action

                  do_action( 'woo_batches_admin_settings_before_output_action_{id}', array $settings, string $current_section );
                

Copy signature

Parameters

$settingsarray

Includes all settings

$current_sectionstring

The current settings section

Since: 1.5.0

Sources:

• class-woo-batches-admin-settings-page.php:157

filterwoo_batches_admin_settings_export_csv_columnsWoo Batches

This filter filters all available settings export CSV columns

                  apply_filters( 'woo_batches_admin_settings_export_csv_columns', array $export_columns );
                

Copy signature

Parameters

$export_columnsarray

The export CSV columns

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:186

filterwoo_batches_admin_settings_export_form_methodWoo Batches

This filter filters the admin settings export form method

                  apply_filters( 'woo_batches_admin_settings_export_form_method', string $settings_export_form_method );
                

Copy signature

Parameters

$settings_export_form_methodstring

The form method for the settings export form

Since: 1.5.2

Sources:

• export.php:20

actionwoo_batches_admin_settings_field_{setting_type}Woo Batches

This hook fires when the settings type don't fits

                  do_action( 'woo_batches_admin_settings_field_{setting_type}', array $setting );
                

Copy signature

Parameters

$settingarray

Includes setting parameters

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:466

filterwoo_batches_admin_settings_form_method_tab_{current_tab}Woo Batches

This filter filters the admin settings form method

                  apply_filters( 'woo_batches_admin_settings_form_method_tab_{current_tab}', string $settings_form_method );
                

Copy signature

Parameters

$settings_form_methodstring

The form method for the settings form

Since: 1.5.2

Sources:

• settings.php:65

filterwoo_batches_admin_settings_get_export_settings_urlWoo Batches

This filter filters the export settings URL

                  apply_filters( 'woo_batches_admin_settings_get_export_settings_url', string $export_settings_url );
                

Copy signature

Parameters

$export_settings_urlstring

The export settings URL

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:169

filterwoo_batches_admin_settings_get_import_settings_urlWoo Batches

This filter filters the import settings URL

                  apply_filters( 'woo_batches_admin_settings_get_import_settings_url', string $import_settings_url );
                

Copy signature

Parameters

$import_settings_urlstring

The import settings URL

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:145

filterwoo_batches_admin_settings_get_optionWoo Batches

This filter filters the current setting value (option)

                  apply_filters( 'woo_batches_admin_settings_get_option', mixed $setting_value, int|string $setting_id );
                

Copy signature

Parameters

$setting_valuemixed

The setting value (or default)

$setting_idint|string

The setting ID

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:290

filterwoo_batches_admin_settings_import_form_methodWoo Batches

This filter filters the admin settings import form method

                  apply_filters( 'woo_batches_admin_settings_import_form_method', string $settings_import_form_method );
                

Copy signature

Parameters

$settings_import_form_methodstring

The form method for the settings import form

Since: 1.5.2

Sources:

• import.php:28

filterwoo_batches_admin_settings_output_action_{id}_output_settings_fieldsWoo Batches

This filter filters if the settings fields should be outputted

                  apply_filters( 'woo_batches_admin_settings_output_action_{id}_output_settings_fields', bool $output_settings_fields, string $current_section );
                

Copy signature

Parameters

$output_settings_fieldsbool

If settings fields should be outputted

$current_sectionstring

The current settings section

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-page.php:168

filterwoo_batches_admin_settings_page_title_actionsWoo Batches

This filter filters the admin settings page title actions

                  apply_filters( 'woo_batches_admin_settings_page_title_actions', array $page_title_actions );
                

Copy signature

Parameters

$page_title_actionsarray

Includes the page title actions

Since: 1.7.0

Sources:

• settings.php:35

filterwoo_batches_admin_settings_sanitize_optionWoo Batches

This filter filters the sanitized settings option

                  apply_filters( 'woo_batches_admin_settings_sanitize_option', mixed|null $value, mixed $option, array|mixed|null|string $raw_value );
                

Copy signature

Parameters

$valuemixed|null

The value

$optionmixed

The option

$raw_valuearray|mixed|null|string

The raw value

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:544

filterwoo_batches_admin_settings_sanitize_option_{option_name}Woo Batches

Sanitize the value of an option by option name

                  apply_filters( 'woo_batches_admin_settings_sanitize_option_{option_name}', mixed|null $value, mixed $option, array|mixed|null|string $raw_value );
                

Copy signature

Parameters

$valuemixed|null

The value

$optionmixed

The option

$raw_valuearray|mixed|null|string

The raw value

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:556

actionwoo_batches_admin_settings_save_{current_tab}Woo Batches

This hook fires when a settings page gets saved

                  do_action( 'woo_batches_admin_settings_save_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:236

actionwoo_batches_admin_settings_save_{id}Woo Batches

This hook fires during the saving of settings

                  do_action( 'woo_batches_admin_settings_save_{id}', string $current_section );
                

Copy signature

Parameters

$current_sectionstring

The current settings section

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings-page.php:204

actionwoo_batches_admin_settings_save_fieldsWoo Batches

This hook fires when settings fields getting saved

                  do_action( 'woo_batches_admin_settings_save_fields', array $update_options );
                

Copy signature

Parameters

$update_optionsarray

Includes all options to update

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:588

actionwoo_batches_admin_settings_savedWoo Batches

This hook fires when a settings page was saved

                  do_action( 'woo_batches_admin_settings_saved' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-admin-settings.php:248

actionwoo_batches_admin_settings_saved_fieldsWoo Batches

This hook fires when settings fields are saved

                  do_action( 'woo_batches_admin_settings_saved_fields', array $update_options );
                

Copy signature

Parameters

$update_optionsarray

Includes all options to update

Since: 1.4.6

Sources:

• class-woo-batches-admin-settings.php:613

actionwoo_batches_admin_settings_sections_{current_tab}Woo Batches

This hook fires during the settings sections output

                  do_action( 'woo_batches_admin_settings_sections_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• settings.php:92

actionwoo_batches_admin_settings_tabsWoo Batches

This hook fires during the settings tabs output

                  do_action( 'woo_batches_admin_settings_tabs' );
                

Copy signature

Since: 1.0.0

Sources:

• settings.php:82

filterwoo_batches_admin_settings_tabs_arrayWoo Batches

This filter filters the admin settings tabs array

                  apply_filters( 'woo_batches_admin_settings_tabs_array', array $tabs );
                

Copy signature

Parameters

$tabsarray

Includes the settings tabs

Since: 1.5.2

Sources:

• settings.php:15
• class-woo-batches-admin.php:412

filterwoo_batches_admin_settings_update_optionWoo Batches

This filter filters the settings update option

                  apply_filters( 'woo_batches_admin_settings_update_option', mixed|null $setting_value, int|string $setting_id );
                

Copy signature

Parameters

$setting_valuemixed|null

The setting value

$setting_idint|string

The setting ID

Since: 1.5.2

Sources:

• class-woo-batches-admin-settings.php:600

filterwoo_batches_admin_settings_views_arrayWoo Batches

This filter filters the admin settings views

                  apply_filters( 'woo_batches_admin_settings_views_array', array $settings_views );
                

Copy signature

Parameters

$settings_viewsarray

Includes the settings views

Since: 1.5.2

Sources:

• class-woo-batches-admin.php:421

filterwoo_batches_admin_setup_wizard_get_current_step_indexWoo Batches

This filter filters the current setup wizard step index

                  apply_filters( 'woo_batches_admin_setup_wizard_get_current_step_index', int $current_step_index );
                

Copy signature

Parameters

$current_step_indexint

The current step index

Since: 1.5.3

Sources:

• class-woo-batches-admin-setup-wizard.php:173

filterwoo_batches_admin_setup_wizard_get_current_step_keyWoo Batches

This filter filters the current setup wizard step key

                  apply_filters( 'woo_batches_admin_setup_wizard_get_current_step_key', string $current_step_key );
                

Copy signature

Parameters

$current_step_keystring

The current step key

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:154

filterwoo_batches_admin_setup_wizard_get_error_messageWoo Batches

This filter filters the setup wizard error message

                  apply_filters( 'woo_batches_admin_setup_wizard_get_error_message', false|mixed $error_message );
                

Copy signature

Parameters

$error_messagefalse|mixed

The error message

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:326

filterwoo_batches_admin_setup_wizard_get_first_steps_listWoo Batches

This filter filters the setup wizard first steps list

                  apply_filters( 'woo_batches_admin_setup_wizard_get_first_steps_list', array $first_steps_list );
                

Copy signature

Parameters

$first_steps_listarray

Includes all first steps

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:458

filterwoo_batches_admin_setup_wizard_get_next_stepWoo Batches

This filter filters the next step key

                  apply_filters( 'woo_batches_admin_setup_wizard_get_next_step', int|string $next_step_key );
                

Copy signature

Parameters

$next_step_keyint|string

The next step key

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:302

filterwoo_batches_admin_setup_wizard_get_setup_wizard_stepsWoo Batches

This filter filters the setup wizard steps

                  apply_filters( 'woo_batches_admin_setup_wizard_get_setup_wizard_steps', array $steps );
                

Copy signature

Parameters

$stepsarray

Includes the steps

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:523

filterwoo_batches_admin_setup_wizard_get_stepWoo Batches

This filter filters a setup wizard step given by step key

                  apply_filters( 'woo_batches_admin_setup_wizard_get_step', array|false $step );
                

Copy signature

Parameters

$steparray|false

The requested step

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:267

filterwoo_batches_admin_setup_wizard_get_step_indexWoo Batches

This filter filters the setup wizard step index

                  apply_filters( 'woo_batches_admin_setup_wizard_get_step_index', int $step_index );
                

Copy signature

Parameters

$step_indexint

The step index

Since: 1.5.3

Sources:

• class-woo-batches-admin-setup-wizard.php:194

filterwoo_batches_admin_setup_wizard_get_step_urlWoo Batches

This filter filters the setup wizard step URL

                  apply_filters( 'woo_batches_admin_setup_wizard_get_step_url', string $step_url );
                

Copy signature

Parameters

$step_urlstring

The step URL

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:243

filterwoo_batches_admin_setup_wizard_get_stepsWoo Batches

This filter filters the setup wizard get steps

                  apply_filters( 'woo_batches_admin_setup_wizard_get_steps', array $steps );
                

Copy signature

Parameters

$stepsarray

Includes the steps

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:211

actionwoo_batches_admin_status_{current_tab}Woo Batches

This hook fires during the status content output

                  do_action( 'woo_batches_admin_status_{current_tab}' );
                

Copy signature

Since: 1.0.0

Sources:

• statuses.php:60

actionwoo_batches_admin_status_after_system_status_reportWoo Batches

This hook fires after the system status report

                  do_action( 'woo_batches_admin_status_after_system_status_report' );
                

Copy signature

Since: 1.0.0

Sources:

• system.php:643

filterwoo_batches_admin_status_format_plugin_dataWoo Batches

This filter filters the admin status formatted plugin data

                  apply_filters( 'woo_batches_admin_status_format_plugin_data', array $plugin_data );
                

Copy signature

Parameters

$plugin_dataarray

Includes all formatted plugin data

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:389

filterwoo_batches_admin_status_generate_system_reportWoo Batches

This filter filters the admin status system report

                  apply_filters( 'woo_batches_admin_status_generate_system_report', array $system_report );
                

Copy signature

Parameters

$system_reportarray

Includes the whole system report

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:68

filterwoo_batches_admin_status_get_active_plugin_detailsWoo Batches

This filter filters the admin status active plugins details

                  apply_filters( 'woo_batches_admin_status_get_active_plugin_details', array $active_plugins_data );
                

Copy signature

Parameters

$active_plugins_dataarray

Includes the active plugins

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:332

filterwoo_batches_admin_status_get_database_detailsWoo Batches

This filter filters the admin status database details

                  apply_filters( 'woo_batches_admin_status_get_database_details', array $database_details );
                

Copy signature

Parameters

$database_detailsarray

Includes the database details

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:270

filterwoo_batches_admin_status_get_inactive_plugin_detailsWoo Batches

This filter filters the admin status inactive plugins details

                  apply_filters( 'woo_batches_admin_status_get_inactive_plugin_details', array $inactive_plugins_data );
                

Copy signature

Parameters

$inactive_plugins_dataarray

Includes the inactive plugins

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:366

filterwoo_batches_admin_status_get_security_detailsWoo Batches

This filter filters the admin status security details

                  apply_filters( 'woo_batches_admin_status_get_security_details', array $security_details );
                

Copy signature

Parameters

$security_detailsarray

Includes the security details

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:296

filterwoo_batches_admin_status_get_server_environment_detailsWoo Batches

This filter filters the admin status server environment details

                  apply_filters( 'woo_batches_admin_status_get_server_environment_details', array $server_environment_details );
                

Copy signature

Parameters

$server_environment_detailsarray

Includes the server environment details

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:197

filterwoo_batches_admin_status_get_settings_detailsWoo Batches

This filter filters the admin status settings details

                  apply_filters( 'woo_batches_admin_status_get_settings_details', array $settings_details );
                

Copy signature

Parameters

$settings_detailsarray

Includes all settings details

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:418

filterwoo_batches_admin_status_get_theme_detailsWoo Batches

This filter filters the admin status active theme details

                  apply_filters( 'woo_batches_admin_status_get_theme_details', array $active_theme_info );
                

Copy signature

Parameters

$active_theme_infoarray

Includes all active theme details

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:474

filterwoo_batches_admin_status_get_timezone_nameWoo Batches

This filter filters the admin status timezone name

                  apply_filters( 'woo_batches_admin_status_get_timezone_name', string $timezone_name );
                

Copy signature

Parameters

$timezone_namestring

The timezone name

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions.php:114

filterwoo_batches_admin_status_get_utc_offsetWoo Batches

This filter filters the admin status UTC offset

                  apply_filters( 'woo_batches_admin_status_get_utc_offset', string $utc_offset, string $formatted_offset );
                

Copy signature

Parameters

$utc_offsetstring

The UTC offset

$formatted_offsetstring

The formatted offset

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions.php:150

filterwoo_batches_admin_status_get_wp_environment_detailsWoo Batches

This filter filters the admin status WordPress environment details

                  apply_filters( 'woo_batches_admin_status_get_wp_environment_details', array $wp_environment_details );
                

Copy signature

Parameters

$wp_environment_detailsarray

Includes the WordPress environment details

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-system.php:156

filterwoo_batches_admin_status_scheduled_actions_list_table_get_hook_callbacksWoo Batches

This filter filters the admin status scheduled actions table hook callbacks

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_get_hook_callbacks', array $hook_callbacks );
                

Copy signature

Parameters

$hook_callbacksarray

Includes all hook callbacks

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:388

filterwoo_batches_admin_status_scheduled_actions_list_table_get_table_classesWoo Batches

This filter filters the admin status scheduled actions table classes

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_get_table_classes', array $table_classes );
                

Copy signature

Parameters

$table_classesarray

Includes all table classes

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:175

filterwoo_batches_admin_status_scheduled_actions_list_table_no_itemsWoo Batches

This filter filters the admin status scheduled actions list table no items message

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_no_items', string $message );
                

Copy signature

Parameters

$messagestring

The no items message

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:351

filterwoo_batches_admin_status_scheduled_actions_list_table_populate_callbackWoo Batches

This filter filters the admin status scheduled actions populate callback

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_populate_callback', array $callback );
                

Copy signature

Parameters

$callbackarray

Includes the populate callback

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:432

filterwoo_batches_admin_status_scheduled_actions_list_table_process_searchWoo Batches

This filter filters the admin status scheduled actions table process search

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_process_search', array $cron_events );
                

Copy signature

Parameters

$cron_eventsarray

Includes all cron events

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:569

filterwoo_batches_admin_status_scheduled_actions_list_table_process_sortingWoo Batches

This filter filters the admin status scheduled actions table process sorting

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_process_sorting', array $cron_events );
                

Copy signature

Parameters

$cron_eventsarray

Includes all cron events

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:620

actionwoo_batches_admin_status_scheduled_actions_list_table_row_actionsWoo Batches

This hook fires when a custom link gets added to the row actions

                  do_action( 'woo_batches_admin_status_scheduled_actions_list_table_row_actions', array $links );
                

Copy signature

Parameters

$linksarray

Includes the schedules actions table row links

Since: 1.0.0

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:334

filterwoo_batches_admin_status_scheduled_actions_list_table_sortable_columnsWoo Batches

This filter filters the admin status scheduled actions table sortable columns

                  apply_filters( 'woo_batches_admin_status_scheduled_actions_list_table_sortable_columns', array $valid_sortable_columns );
                

Copy signature

Parameters

$valid_sortable_columnsarray

Includes all valid sortable columns

Since: 1.5.2

Sources:

• class-woo-batches-admin-status-scheduled-actions-list-table.php:588

actionwoo_batches_admin_statuses_tabsWoo Batches

This hook fires during the statuses tabs output

                  do_action( 'woo_batches_admin_statuses_tabs' );
                

Copy signature

Since: 1.0.0

Sources:

• statuses.php:49

filterwoo_batches_admin_statuses_tabs_arrayWoo Batches

This filter filters the admin statuses tabs array

                  apply_filters( 'woo_batches_admin_statuses_tabs_array', array $tabs );
                

Copy signature

Parameters

$tabsarray

Includes the statuses tabs

Since: 1.5.2

Sources:

• statuses.php:15
• class-woo-batches-admin.php:439

actionwoo_batches_admin_wc_batches_expired_emailWoo Batches

This hook fires when a batches expired email can be sent

                  do_action( 'woo_batches_admin_wc_batches_expired_email', array $batches_details );
                

Copy signature

Parameters

$batches_detailsarray

Includes all required batches [ $expired_batches ]

Since: 1.3.0

Sources:

• class-woo-batches-admin-wc-emails.php:152

actionwoo_batches_admin_wc_batches_stock_low_emailWoo Batches

This hook fires when a batches stock low email can be sent

                  do_action( 'woo_batches_admin_wc_batches_stock_low_email', array $batches_details );
                

Copy signature

Parameters

$batches_detailsarray

Includes all required batches [ $stock_low_batches ]

Since: 1.3.0

Sources:

• class-woo-batches-admin-wc-emails.php:121

actionwoo_batches_admin_wc_email_batches_detailsWoo Batches

This hook fires when the email batches table including all details should be outputted

                  do_action( 'woo_batches_admin_wc_email_batches_details', array $batches_details );
                

Copy signature

Parameters

$batches_detailsarray

Includes all required details [ $batches, $plain_text ]

Since: 1.3.0

Sources:

• batches-stock-low.php:35
• batches-expired.php:35
• batches-stock-low.php:35
• batches-expired.php:35

filterwoo_batches_admin_wc_orders_allocated_item_batchesWoo Batches

This filter filters the allocated item batches for an order

                  apply_filters( 'woo_batches_admin_wc_orders_allocated_item_batches', array $allocated_item_batches );
                

Copy signature

Parameters

$allocated_item_batchesarray

Includes all allocated item batches

Since: 1.5.2

Sources:

• class-woo-batches-wc-orders.php:561

filterwoo_batches_admin_wc_orders_order_item_quantityWoo Batches

This filter filters the needed quantity for an order item

                  apply_filters( 'woo_batches_admin_wc_orders_order_item_quantity', int $order_item_quantity, int $product_id );
                

Copy signature

Parameters

$order_item_quantityint

The order item quantity

$product_idint

The product ID

Since: 1.5.2

Sources:

• class-woo-batches-wc-orders.php:490

filterwoo_batches_admin_wc_orders_update_batch_on_reduce_order_stockWoo Batches

This filter filters if the batches should be updated on reduce of an order stock

                  apply_filters( 'woo_batches_admin_wc_orders_update_batch_on_reduce_order_stock', bool $reduce_order_stock );
                

Copy signature

Parameters

$reduce_order_stockbool

If reduce order stock

Since: 1.5.2

Sources:

• class-woo-batches-wc-orders.php:145

filterwoo_batches_admin_wc_products_get_import_export_columnsWoo Batches

This filter filters the custom product importer exporter columns

                  apply_filters( 'woo_batches_admin_wc_products_get_import_export_columns', array $import_export_columns );
                

Copy signature

Parameters

$import_export_columnsarray

Includes the import export columns

Since: 1.5.2

Sources:

• class-woo-batches-admin-wc-products.php:563

actionwoo_batches_after_get_templateWoo Batches

This hook fires after a template was loaded

                  do_action( 'woo_batches_after_get_template', string $template, string $args );
                

Copy signature

Parameters

$templatestring

The template

$argsstring

The args for the template

Since: 1.0.0

Sources:

• woo-batches-core-functions.php:190

actionwoo_batches_after_loadWoo Batches

This hook fires after the plugin load

                  do_action( 'woo_batches_after_load' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches.php:69

actionwoo_batches_after_product_batches_tableWoo Batches

This hook fires after the batches table on the single product page

                  do_action( 'woo_batches_after_product_batches_table' );
                

Copy signature

Since: 1.0.0

Sources:

• batches.php:61

actionwoo_batches_before_get_templateWoo Batches

This hook fires before a template gets loaded

                  do_action( 'woo_batches_before_get_template', string $template, string $args );
                

Copy signature

Parameters

$templatestring

The template

$argsstring

The args for the template

Since: 1.0.0

Sources:

• woo-batches-core-functions.php:177

actionwoo_batches_before_loadWoo Batches

This hook fires before the plugin load

                  do_action( 'woo_batches_before_load' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches.php:53

filterwoo_batches_cron_jobs_filter_cron_schedulesWoo Batches

This filter filters the custom plugin cron job schedules

                  apply_filters( 'woo_batches_cron_jobs_filter_cron_schedules', array $schedules );
                

Copy signature

Parameters

$schedulesarray

Since: 1.5.2

Sources:

• class-woo-batches-cron-jobs.php:71

filterwoo_batches_cron_jobs_get_cron_hooksWoo Batches

This filter filters all cron job hooks from the plugin

                  apply_filters( 'woo_batches_cron_jobs_get_cron_hooks', array $cron_hooks, bool $include_helper, bool $is_uninstall );
                

Copy signature

Parameters

$cron_hooksarray

Includes all cron hooks

$include_helperbool

If the helper plugins should be included

$is_uninstallbool

If is uninstall of the plugin

Since: 1.5.2

Sources:

• class-woo-batches-cron-jobs.php:409

filterwoo_batches_cron_jobs_get_formatted_cron_eventsWoo Batches

This filter filters all formatted plugin cron events

                  apply_filters( 'woo_batches_cron_jobs_get_formatted_cron_events', array $formatted_cron_events );
                

Copy signature

Parameters

$formatted_cron_eventsarray

Includes all formatted plugin cron events

Since: 1.5.2

Sources:

• class-woo-batches-cron-jobs.php:171

filterwoo_batches_data_store_additional_order_by_directivesWoo Batches

This filter filters the data store exists by query

                  apply_filters( 'woo_batches_data_store_additional_order_by_directives', string $additional_directives );
                

Copy signature

Parameters

$additional_directivesstring

The additional order by directives

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:748

filterwoo_batches_data_store_count_by_queryWoo Batches

This filter filters the data store count by query

                  apply_filters( 'woo_batches_data_store_count_by_query', string $count_by_query );
                

Copy signature

Parameters

$count_by_querystring

The count by query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:455

filterwoo_batches_data_store_delete_queryWoo Batches

This filter filters the data store delete query

                  apply_filters( 'woo_batches_data_store_delete_query', string $delete_query );
                

Copy signature

Parameters

$delete_querystring

The delete query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:363

filterwoo_batches_data_store_exists_by_queryWoo Batches

This filter filters the data store exists by query

                  apply_filters( 'woo_batches_data_store_exists_by_query', string $exists_by_query );
                

Copy signature

Parameters

$exists_by_querystring

The exists by query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:496

filterwoo_batches_data_store_find_all_by_queryWoo Batches

This filter filters the data store find all by query

                  apply_filters( 'woo_batches_data_store_find_all_by_query', string $find_all_by_query );
                

Copy signature

Parameters

$find_all_by_querystring

The find all by query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:255

filterwoo_batches_data_store_find_all_queryWoo Batches

This filter filters the data store find all query

                  apply_filters( 'woo_batches_data_store_find_all_query', string $find_all_query );
                

Copy signature

Parameters

$find_all_querystring

The find all query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:204

filterwoo_batches_data_store_find_by_queryWoo Batches

This filter filters the data store find by query

                  apply_filters( 'woo_batches_data_store_find_by_query', string $find_by_query );
                

Copy signature

Parameters

$find_by_querystring

The find by query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:159

filterwoo_batches_data_store_find_queryWoo Batches

This filter filters the data store find query

                  apply_filters( 'woo_batches_data_store_find_query', string $find_query );
                

Copy signature

Parameters

$find_querystring

The find query

Since: 1.5.2

Sources:

• abstract-class-woo-batches-data-store.php:117

filterwoo_batches_date_formatWoo Batches

This filter filters the date format

                  apply_filters( 'woo_batches_date_format', string $date_format );
                

Copy signature

Parameters

$date_formatstring

The date format

Since: 1.5.2

Sources:

• woo-batches-formatting-functions.php:26

filterwoo_batches_db_missing_tablesWoo Batches

This filter filters the missing DB tables

                  apply_filters( 'woo_batches_db_missing_tables', string|array $missing_tables );
                

Copy signature

Parameters

$missing_tablesstring|array

Includes the missing tables

Since: 1.5.2

Sources:

• woo-batches-core-functions.php:144

filterwoo_batches_dependencies_check_plugin_slugWoo Batches

This filter filters the plugin slug

                  apply_filters( 'woo_batches_dependencies_check_plugin_slug', string $plugin_slug );
                

Copy signature

Parameters

$plugin_slugstring

The plugin slug to check

Since: 1.5.2

Sources:

• class-woo-batches-dependencies.php:244

filterwoo_batches_dependencies_is_loadableWoo Batches

This filter filters if the plugin is loadable

                  apply_filters( 'woo_batches_dependencies_is_loadable', bool $loadable );
                

Copy signature

Parameters

$loadablebool

If is loadable or not

Since: 1.5.2

Sources:

• class-woo-batches-dependencies.php:185

filterwoo_batches_documentation_urlWoo Batches

This filter filters the URL to the plugin documentation

                  apply_filters( 'woo_batches_documentation_url', string $documentation_url );
                

Copy signature

Parameters

$documentation_urlstring

The URL to the plugin documentation

Since: 1.5.2

Sources:

• class-woo-batches-install.php:492

filterwoo_batches_enable_setup_wizardWoo Batches

This filter filters if the setup wizard should be enabled or not

                  apply_filters( 'woo_batches_enable_setup_wizard', bool $enabled );
                

Copy signature

Parameters

$enabledbool

If setup wizard enabled or not

Since: 1.5.2

Sources:

• class-woo-batches-admin-setup-wizard.php:76

filterwoo_batches_enable_update_functionsWoo Batches

This filter filters if the update functions should be used

                  apply_filters( 'woo_batches_enable_update_functions', bool $enable_update_functions );
                

Copy signature

Parameters

$enable_update_functionsbool

If update functions enabled or not

Since: 1.5.2

Sources:

• class-woo-batches-install.php:416

filterwoo_batches_expert_setting_delete_data_uninstall_modeWoo Batches

This filter filters the expert delete data uninstall mode to remove all data during uninstall of the plugin

                  apply_filters( 'woo_batches_expert_setting_delete_data_uninstall_mode', string $uninstall_mode );
                

Copy signature

Parameters

$uninstall_modestring

The expert uninstall mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:22

filterwoo_batches_format_log_entryWoo Batches

This filter filters the formatted log entry

                  apply_filters( 'woo_batches_format_log_entry', array $log_entry );
                

Copy signature

Parameters

$log_entryarray

The log entry

Since: 1.5.2

Sources:

• abstract-class-woo-batches-log-handler.php:45

filterwoo_batches_general_display_batches_expiration_date_order_item_meta_data_modeWoo Batches

This filter filters the display batches expiration date order item meta data mode

                  apply_filters( 'woo_batches_general_display_batches_expiration_date_order_item_meta_data_mode', string $item_meta_data_mode );
                

Copy signature

Parameters

$item_meta_data_modestring

The item meta data mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:155

filterwoo_batches_general_display_batches_order_item_meta_data_modeWoo Batches

This filter filters the display batches order item meta data mode

                  apply_filters( 'woo_batches_general_display_batches_order_item_meta_data_mode', string $item_meta_data_mode );
                

Copy signature

Parameters

$item_meta_data_modestring

The item meta data mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:136

filterwoo_batches_general_display_batches_order_items_modeWoo Batches

This filter filters the display batches order items mode

                  apply_filters( 'woo_batches_general_display_batches_order_items_mode', string $order_items_mode );
                

Copy signature

Parameters

$order_items_modestring

The order items mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:117

filterwoo_batches_general_display_batches_product_shop_modeWoo Batches

This filter filters the display batches product shop mode

                  apply_filters( 'woo_batches_general_display_batches_product_shop_mode', string $product_shop_mode );
                

Copy signature

Parameters

$product_shop_modestring

The product shop mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:98

filterwoo_batches_general_display_batches_product_shop_thresholdWoo Batches

This filter filters the display batches product shop threshold

                  apply_filters( 'woo_batches_general_display_batches_product_shop_threshold', string $product_shop_threshold );
                

Copy signature

Parameters

$product_shop_thresholdstring

The product shop threshold

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:174

filterwoo_batches_general_display_batches_products_overview_modeWoo Batches

This filter filters the display batches products overview mode

                  apply_filters( 'woo_batches_general_display_batches_products_overview_mode', string $products_overview_mode );
                

Copy signature

Parameters

$products_overview_modestring

The products overview mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:79

filterwoo_batches_general_display_header_actions_modeWoo Batches

This filter filters the display status of the header actions

                  apply_filters( 'woo_batches_general_display_header_actions_mode', string $display_mode );
                

Copy signature

Parameters

$display_modestring

The display mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:41

filterwoo_batches_general_display_setup_wizard_update_modeWoo Batches

This filter filters the display mode of the setup wizard after an update

                  apply_filters( 'woo_batches_general_display_setup_wizard_update_mode', string $display_mode );
                

Copy signature

Parameters

$display_modestring

The display mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:60

filterwoo_batches_general_notification_batches_stock_low_thresholdWoo Batches

This filter filters the notification batches stock low threshold

                  apply_filters( 'woo_batches_general_notification_batches_stock_low_threshold', string $stock_low_threshold );
                

Copy signature

Parameters

$stock_low_thresholdstring

The stock low threshold

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:269

filterwoo_batches_get_current_sectionWoo Batches

This filter filters the current page section

                  apply_filters( 'woo_batches_get_current_section', string $current_section );
                

Copy signature

Parameters

$current_sectionstring

The current section

Since: 1.7.0

Sources:

• woo-batches-core-functions.php:506

filterwoo_batches_get_current_tabWoo Batches

This filter filters the current page tab

                  apply_filters( 'woo_batches_get_current_tab', string $current_tab );
                

Copy signature

Parameters

$current_tabstring

The current tab

Since: 1.7.0

Sources:

• woo-batches-core-functions.php:452

filterwoo_batches_get_current_viewWoo Batches

This filter filters the current page view

                  apply_filters( 'woo_batches_get_current_view', string $current_view );
                

Copy signature

Parameters

$current_viewstring

The current view

Since: 1.7.0

Sources:

• woo-batches-core-functions.php:479

filterwoo_batches_get_product_textWoo Batches

This filter filters the product text

                  apply_filters( 'woo_batches_get_product_text', string $product_text, WC_Product|bool|null $product );
                

Copy signature

Parameters

$product_textstring

The product text

$productWC_Product|bool|null

The product object

Since: 1.8.0

Sources:

• woo-batches-product-functions.php:79

filterwoo_batches_includesWoo Batches

This filter filters includes (function files)

                  apply_filters( 'woo_batches_includes', array $includes );
                

Copy signature

Parameters

$includesarray

Includes all function filenames

Since: 1.0.0

Sources:

• class-woo-batches.php:131

filterwoo_batches_install_get_core_capabilitiesWoo Batches

This filter filters the plugins core capabilities

                  apply_filters( 'woo_batches_install_get_core_capabilities', array $capabilities );
                

Copy signature

Parameters

$capabilitiesarray

Includes all capabilities

Since: 1.5.2

Sources:

• class-woo-batches-install.php:546

filterwoo_batches_install_get_tablesWoo Batches

This filter filters the plugin tables

                  apply_filters( 'woo_batches_install_get_tables', array $tables );
                

Copy signature

Parameters

$tablesarray

Includes all plugin tables

Since: 1.5.2

Sources:

• class-woo-batches-install.php:693

actionwoo_batches_install_plugin_updatedWoo Batches

This hook fires if the plugin has been updated

                  do_action( 'woo_batches_install_plugin_updated' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-install.php:146

filterwoo_batches_install_skip_create_directories_filesWoo Batches

This filter filters if the creation of the directories and files should be skipped

                  apply_filters( 'woo_batches_install_skip_create_directories_files', bool $skip );
                

Copy signature

Parameters

$skipbool

If should be skipped

Since: 1.5.2

Sources:

• class-woo-batches-install.php:249

actionwoo_batches_installedWoo Batches

This hook fires after the plugin is installed successfully

                  do_action( 'woo_batches_installed' );
                

Copy signature

Since: 1.0.0

Sources:

• class-woo-batches-install.php:130

filterwoo_batches_is_actionWoo Batches

This filter filters if the current action is an action on a plugins page

                  apply_filters( 'woo_batches_is_action', bool $is_action );
                

Copy signature

Parameters

$is_actionbool

If is action on page or not

Since: 1.5.2

Sources:

• woo-batches-core-functions.php:297

actionwoo_batches_log_deleteWoo Batches

This hook fires after a log file was deleted

                  do_action( 'woo_batches_log_delete', string $log_file, bool $deleted );
                

Copy signature

Parameters

$log_filestring

The log file name

$deletedbool

If the log was was deleted or not

Since: 1.0.0

Sources:

• class-woo-batches-log-handler-file.php:197

actionwoo_batches_log_downloadWoo Batches

This hook fires after a log file download was triggered

                  do_action( 'woo_batches_log_download', string $log_file );
                

Copy signature

Parameters

$log_filestring

The log file name

Since: 1.0.0

Sources:

• class-woo-batches-log-handler-file.php:228

filterwoo_batches_log_handler_file_add_messageWoo Batches

This filter filters the log file message

                  apply_filters( 'woo_batches_log_handler_file_add_message', string $message, string $log_file );
                

Copy signature

Parameters

$messagestring

Log message

$log_filestring

Log file

Since: 1.5.2

Sources:

• class-woo-batches-log-handler-file.php:138

filterwoo_batches_log_handler_file_get_log_file_entry_levelWoo Batches

This filter filters the log file entry level

                  apply_filters( 'woo_batches_log_handler_file_get_log_file_entry_level', string $level );
                

Copy signature

Parameters

$levelstring

Log entry level

Since: 1.5.2

Sources:

• class-woo-batches-log-handler-file.php:341

filterwoo_batches_log_handler_file_get_log_file_entry_messageWoo Batches

This filter filters the log file entry message

                  apply_filters( 'woo_batches_log_handler_file_get_log_file_entry_message', string $message );
                

Copy signature

Parameters

$messagestring

Log message

Since: 1.5.2

Sources:

• class-woo-batches-log-handler-file.php:362

filterwoo_batches_log_handler_file_get_log_file_entry_timestampWoo Batches

This filter filters the log file entry timestamp

                  apply_filters( 'woo_batches_log_handler_file_get_log_file_entry_timestamp', string $timestamp );
                

Copy signature

Parameters

$timestampstring

Log entry timestamp

Since: 1.5.2

Sources:

• class-woo-batches-log-handler-file.php:319

filterwoo_batches_log_handler_file_get_log_filesWoo Batches

This filter filters the log files

                  apply_filters( 'woo_batches_log_handler_file_get_log_files', array $result );
                

Copy signature

Parameters

$resultarray

Log files

Since: 1.5.2

Sources:

• class-woo-batches-log-handler-file.php:298

filterwoo_batches_log_handler_file_log_size_limitWoo Batches

This filter filters the log file size limit

                  apply_filters( 'woo_batches_log_handler_file_log_size_limit', int $log_size_limit );
                

Copy signature

Parameters

$log_size_limitint

The log file size limit

Since: 1.5.2

Sources:

• class-woo-batches-log-handler-file.php:60

filterwoo_batches_logger_days_to_retain_logsWoo Batches

This filter filters the days the logger should retain the logs

                  apply_filters( 'woo_batches_logger_days_to_retain_logs', int $days );
                

Copy signature

Parameters

$daysint

The number of days to retain the logs

Since: 1.5.2

Sources:

• class-woo-batches-logger.php:310

filterwoo_batches_logger_log_messageWoo Batches

This filter filters the logger log message

                  apply_filters( 'woo_batches_logger_log_message', string $message, string $level, array $context );
                

Copy signature

Parameters

$messagestring

The log message

$levelstring

The log level

$contextarray

The log context

Since: 1.5.2

Sources:

• class-woo-batches-logger.php:150

filterwoo_batches_order_increase_decrease_trash_untrash_modeWoo Batches

This filter filters the order increase decrease trash untrash mode

                  apply_filters( 'woo_batches_order_increase_decrease_trash_untrash_mode', string $trash_untrash_mode );
                

Copy signature

Parameters

$trash_untrash_modestring

The trash untrash mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:250

filterwoo_batches_product_sell_expired_modeWoo Batches

This filter filters the product sell expired mode

                  apply_filters( 'woo_batches_product_sell_expired_mode', string $sell_expired_mode );
                

Copy signature

Parameters

$sell_expired_modestring

The sell expired mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:231

filterwoo_batches_product_stocks_automatic_synchronization_modeWoo Batches

This filter filters the product stocks automatic synchronization mode

                  apply_filters( 'woo_batches_product_stocks_automatic_synchronization_mode', string $synchronization_mode );
                

Copy signature

Parameters

$synchronization_modestring

The synchronization mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:212

filterwoo_batches_product_stocks_synchronization_modeWoo Batches

This filter filters the product stocks synchronization mode

                  apply_filters( 'woo_batches_product_stocks_synchronization_mode', string $synchronization_mode );
                

Copy signature

Parameters

$synchronization_modestring

The synchronization mode

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:193

filterwoo_batches_register_log_handlersWoo Batches

This filter filters the log handlers

                  apply_filters( 'woo_batches_register_log_handlers', array $handlers );
                

Copy signature

Parameters

$handlersarray

The available handlers

Since: 1.5.2

Sources:

• class-woo-batches-logger.php:49

filterwoo_batches_setting_export_csv_columnsWoo Batches

This filter filters the setting export CSV columns

                  apply_filters( 'woo_batches_setting_export_csv_columns', array $export_columns );
                

Copy signature

Parameters

$export_columnsarray

The export CSV columns

Since: 1.5.2

Sources:

• woo-batches-settings-functions.php:290

actionwoo_batches_setting_exporter_export_csvWoo Batches

This hook fires after the setting exporter exported a CSV and downloaded it

                  do_action( 'woo_batches_setting_exporter_export_csv', resource|false $export_buffer );
                

Copy signature

Parameters

$export_bufferresource|false

The export buffer for the export

Since: 1.5.2

Sources:

• class-woo-batches-setting-exporter.php:109

filterwoo_batches_setting_exporter_export_dataWoo Batches

This filter filters the setting exporter export data

                  apply_filters( 'woo_batches_setting_exporter_export_data', array $export_data );
                

Copy signature

Parameters

$export_dataarray

The export data

Since: 1.5.2

Sources:

• class-woo-batches-setting-exporter.php:85

filterwoo_batches_setting_importer_check_valid_csvWoo Batches

This filter filters if the provided import file should be checked if in valid format

                  apply_filters( 'woo_batches_setting_importer_check_valid_csv', bool $check_valid_csv );
                

Copy signature

Parameters

$check_valid_csvbool

If check for valid CSV should be done

Since: 1.5.2

Sources:

• class-woo-batches-setting-importer.php:236

filterwoo_batches_setting_importer_days_to_retain_importsWoo Batches

This filter filters the days the setting importer should retain the imports

                  apply_filters( 'woo_batches_setting_importer_days_to_retain_imports', int $days );
                

Copy signature

Parameters

$daysint

The number of days to retain the imports

Since: 1.5.2

Sources:

• class-woo-batches-setting-importer.php:70

filterwoo_batches_setting_importer_get_setting_import_dataWoo Batches

This filter filters the setting import data

                  apply_filters( 'woo_batches_setting_importer_get_setting_import_data', array $setting_import_data );
                

Copy signature

Parameters

$setting_import_dataarray

Includes the setting import data

Since: 1.5.2

Sources:

• class-woo-batches-setting-importer.php:216

filterwoo_batches_setting_importer_get_setting_import_file_pathWoo Batches

This filter filters the setting import file path

                  apply_filters( 'woo_batches_setting_importer_get_setting_import_file_path', string $setting_import_file_path );
                

Copy signature

Parameters

$setting_import_file_pathstring

The setting import file path

Since: 1.5.2

Sources:

• class-woo-batches-setting-importer.php:317

filterwoo_batches_setting_importer_get_setting_import_filesWoo Batches

This filter filters the setting import files

                  apply_filters( 'woo_batches_setting_importer_get_setting_import_files', array $result );
                

Copy signature

Parameters

$resultarray

Import files

Since: 1.5.2

Sources:

• class-woo-batches-setting-importer.php:298

filterwoo_batches_setting_importer_valid_csv_filetypesWoo Batches

This filter filters the valid CSV filetypes

                  apply_filters( 'woo_batches_setting_importer_valid_csv_filetypes', array $filetypes );
                

Copy signature

Parameters

$filetypesarray

The allowed filetypes

Since: 1.5.2

Sources:

• class-woo-batches-setting-importer.php:264

filterwoo_batches_time_formatWoo Batches

This filter filters the time format

                  apply_filters( 'woo_batches_time_format', string $time_format );
                

Copy signature

Parameters

$time_formatstring

The time format

Since: 1.5.2

Sources:

• woo-batches-formatting-functions.php:51