README

ecomhouse/checkout-newsletter adds a "Subscribe to the newsletter" opt-in checkbox to the Magento 2 checkout. When the shopper ticks it and places the order, their email is subscribed to the newsletter for the current store. Extracted from the retired ecomhouse/customizedcheckout monolith into a standalone, single-responsibility module.

Requirements

Requirement	Version
Magento Open Source	`2.4.x`
PHP	`>= 8.2`
`ecomhouse/base`	`^1.0`
`ecomhouse/checkout-improvements`	optional, load-after — shares the checkout email layout region

Installation

Composer

composer require ecomhouse/checkout-newsletter
bin/magento module:enable EcomHouse_CheckoutNewsletter
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Manual

cd app/code
mkdir -p EcomHouse/CheckoutNewsletter
# Extract module files into the directory created above
bin/magento module:enable EcomHouse_CheckoutNewsletter
bin/magento setup:upgrade
bin/magento cache:flush

Verify

bin/magento module:status EcomHouse_CheckoutNewsletter

Expected: Module is enabled.

Configuration

None — there is nothing to configure in the admin panel. Once installed, the checkbox appears in checkout automatically, next to the customer-email field, on both Luma and Breeze.

See docs/how-to-use.md for how the opt-in flow works end to end and troubleshooting. Polish version: docs/jak-uzywac.md.

Uninstalling

bin/magento module:disable EcomHouse_CheckoutNewsletter
composer remove ecomhouse/checkout-newsletter
bin/magento setup:upgrade
bin/magento cache:flush

Customers already subscribed to the newsletter stay subscribed — the module only captures the opt-in at checkout time, it doesn't own the subscription record itself (that's core Magento_Newsletter).

Support

Email: opensource@ecom.house
Website: https://ecom.house/
Changelog: CHANGELOG.md
License: OSL-3.0

ecomhouse / checkout-newsletter

Maintainers

Package info

Statistics

Security