EAN Barcode Generator: Developer Hooks and Filters Reference

Developer hooks and filters reference #

EAN for WooCommerce exposes filters, actions, and shortcodes so you can adjust how EANs are generated, validated, displayed, searched, and exported without editing plugin files. Every hook name below is taken directly from the version 5.5.9 source. All hooks use the alg_wc_ean_* prefix.

The settings these hooks relate to live under WPFactory > EAN (also reachable at WooCommerce > Settings > EAN). EAN is stored in product meta under the key set by Advanced > Meta key (option alg_wc_ean_meta_key, default _alg_ean).

Value filters #

These filters fire on a value the plugin is about to use or output, so whatever your callback returns wins.

Force a specific EAN type for one product #

add_filter( 'alg_wc_ean_get_type', function ( $type, $raw_type, $ean, $product_id ) {
    if ( 1234 === (int) $product_id ) {
        $type = 'UPCA';
    }
    return $type;
}, 10, 4 );

Structured data filters #

These control the EAN that is added to product structured data (for Google Search Console and similar).

• alg_wc_ean_product_structured_data_value – arguments $value, $product: the EAN value placed in structured data.
• alg_wc_ean_product_structured_data_markup_key – arguments $key, $type, $product: the key used, for example gtin13 or a custom key.
• alg_wc_ean_product_structured_data_markup_value – arguments $value, $product: the markup value.
• alg_wc_ean_product_structured_data_allow_empty_value – arguments $allow, $product: return true to output the key even when the EAN is empty.

Generate-tool filters #

These fire inside the Generate product tool, so you can control how new EANs are built.

Search filters #

The plugin adds EAN to product and order search. Return false from either filter to skip the plugin’s search handling in a given query.

• alg_wc_ean_search_backend – arguments $enabled, $query, $key: admin-side product search.
• alg_wc_ean_search – arguments $enabled, $wp_query, $key: frontend product search.

REST API filters #

• alg_wc_ean_rest_api_product_ean_key – arguments $key, $response, $product, $request: the JSON key EAN is added under in product responses (default ean).
• alg_wc_ean_rest_api_order_ean_key – arguments $key, $response, $order, $request: the JSON key for order responses (default ean).

The settings gate filter #

alg_wc_ean_settings is how the plugin decides whether a Pro-only field is disabled. In the free version it returns array( 'disabled' => 'disabled' ), which disables the field; in Pro it returns '', removing the attribute. It gates the enable checkboxes for the Barcodes, 2D Barcodes, Print, and Extra Fields sections. It is an internal gate, not intended for store customization.

Barcode and print filters (Pro) #

These fire only when the Pro barcode and print features are active.

The print feature also exposes alg_wc_ean_print_barcodes_to_pdf_default_settings, alg_wc_ean_print_barcodes_to_pdf_template_settings_desc, alg_wc_ean_print_barcode_shop_order_refunded_item_qty, and alg_wc_ean_print_render_meta_box_shop_order_force_refunded.

Other filters #

• alg_wc_ean_settings_page_label – the label of the settings tab and the WPFactory submenu item (default EAN).
• alg_wc_ean_product_function_shortcode_user_capability – the capability required to run [alg_wc_ean_product_function] (default manage_woocommerce).

Actions #

Shortcodes #

The free version registers these shortcodes. They share common attributes: product_id, before, after, on_empty, and (where relevant) parent.

Read a product’s EAN in code #

$ean = get_post_meta( $product_id, '_alg_ean', true );

// Or through the plugin's core helper (respects a custom meta key):
$ean = wpfactory_wc_ean()->core->get_ean( $product_id );

If you changed Advanced > Meta key, read the option first: get_option( 'alg_wc_ean_meta_key', '_alg_ean' ).

Need help? #

If you are extending EAN for WooCommerce and a hook does not behave as expected, contact our team on the EAN for WooCommerce support forum with the hook name and a short code sample.