Filter and action hooks – Address Book

Best practices #

If you are unsure about how to add the code snippet to your website, check our article:
How to safely add code snippets to your WooCommerce website

Actions #

Checkout flow #

• fc_pro_before_shipping_calculator Fires before the shipping calculator is rendered in the cart page.
• fc_pro_after_shipping_calculator Fires after the shipping calculator is rendered in the cart page.
• fc_pro_{$address_type}_address_book_before_entries Fires before the address book entries list is rendered.
• fc_pro_{$address_type}_address_book_after_entries Fires after the address book entries list is rendered.
• fc_pro_address_book_before_checkout_entries_list Fires before the address book entries list items are rendered inside the address book entries list element.
• fc_pro_address_book_after_checkout_entries_list Fires after the address book entries list items are rendered inside the address book entries list element.

Account page #

• fc_pro_edit_account_address_form Fires when rendering the edit address form in the customer account area.

Filters #

Checkout flow #

• fc_pro_address_book_save_checkout_field Allows customization of the “Save address” checkout field.
• fc_pro_address_book_is_address_entry_valid_for_checkout Allows setting custom validation criteria to determine if an address entry should be available to use at checkout.
• fc_pro_{$address_type}_address_label_checkout_field Customize the checkout field attributes for the address label field.

Cart page #

• fc_pro_cart_shipping_calculator_initially_expanded Controls the initial state of the shipping calculator, whether to make it initially expanded or collapsed.
• fc_pro_cart_shipping_calculator_button_classes Customize the shipping calculator update button classes.

Account page #

• fc_pro_address_book_entries_account_start_tag_markup Customize start tag markup for address book entries list on the account page.
• fc_pro_address_book_entries_account_end_tag_markup Customize end tag markup for address book entries list on the account page.
• fc_pro_address_book_entry_account_markup Customize address book list entries markup on the account page.
• fc_pro_address_book_entry_account_edit_button_classes Customize classes for the “Edit” button in address book entries on the account page.
• fc_pro_address_book_entry_account_delete_button_classes Customize classes for the “Delete” button in address book entries on the account page.
• fc_pro_address_book_entry_account_add_button_classes Customize classes for the “Add new address” button on the account page.
• fc_pro_address_book_entry_account_save_button_classes Customize classes for the “Save address” button on the account page.
• fc_pro_address_book_entry_account_cancel_button_classes Customize classes for the “Cancel” button on the account page.
• fc_pro_address_book_edit_address_entry_title Customize address editing page title on the account pages.
• fc_pro_address_book_edit_address_entry_title_element Customize HTML element used to display the address editing page title on the account pages.

Address entries management #

• fc_pro_address_book_entry_before_add Modify the individual address entry before being added.
• fc_pro_address_book_entries_before_add_entry Modify the entire address book entries array before adding the new entry.
• fc_pro_address_book_entry_before_update Modify the individual address entry before being updated.
• fc_pro_address_book_entries_before_update_entry Modify the entire address book entries array before updating.
• fc_pro_before_save_address_from_account Modify address entry before saving from account.
• fc_pro_address_book_address_fields Customize address fields for editing.

Address entries list #

• fc_pro_address_book_entries_start_tag_markup Customize start tag markup for address book entries.
• fc_pro_address_book_entries_end_tag_markup Customize end tag markup for address book entries.
• fc_pro_address_book_entry_markup Customize individual address entry markup.
• fc_pro_address_book_address_sources_options Customize address source options.
• fc_pro_address_book_entry_display_label_remove_skip_list Define fields to skip when displaying address labels.
• fc_pro_address_book_entry_label_markup Customize address entry label markup.
• fc_pro_address_book_entry_display_data Modify address entry data before display.

Data processing #

• fc_pro_process_address_book_entry_field_{$key} Process individual address book entry fields.
• fc_pro_address_book_entry_is_empty_field_keys_skip_list Define fields to skip when checking if address is empty.
• fc_pro_address_book_entry_compare_field_keys_skip_list Define fields to skip when comparing addresses.
• fc_pro_address_book_save_from_order_skip_fields Define fields to skip when saving address from order.
• fc_pro_address_book_save_from_order_extra_fields Define extra fields to include when saving address from order.

Address fields settings #

• fc_pro_address_book_field_keys Customize address book field keys.
• fc_pro_address_book_shipping_force_set_value_field_keys Define shipping fields that should have forced values.
• fc_pro_address_book_billing_force_set_value_field_keys Define billing fields that should have forced values.
• fc_pro_address_book_fields_remove_skip_list Define fields to skip when removing from address book.
• fc_pro_address_book_fields_add_skip_list Define fields to skip when adding to address book.

System & Integrations #

• fc_override_template_with_theme_file Allow themes to override template files.
• fc_pro_override_template_with_theme_file Pro version template override filter.
• fc_pro_address_book_js_settings Modify JavaScript settings for address book functionality.
• fc_pro_address_book_migration_users_per_request Control batch size for address book migration.
• fc_pro_address_book_privacy_export_address_book_entry_props Define fields to export for privacy personal data report.
• fc_pro_address_book_privacy_export_address_book_entry_field_value Customize field values for privacy personal data report.
• fc_adb_enable_compat_plugin_{plugin_slug} Controls whether Address Book should load compatibility features for a specific plugin.
• fc_adb_enable_compat_theme_{theme_slug} Controls whether Address Book should load compatibility features for a specific theme.
• fc_adb_enable_compat_plugin_style_{plugin_slug} Controls whether Address Book should load compatibility styles for specific pages and plugins.
• fc_adb_enable_compat_theme_style_{theme_slug} Controls whether Address Book should load compatibility styles for specific pages and theme.