ppl / module-order-comment
Checkout comment field for Magento 2 that stores customer notes on the order and shows them in admin.
PPL Order Comment for Magento 2
PPL Order Comment adds a checkout comment field that stores customer notes with the quote and order and displays them in the Magento admin.
What It Adds
- Checkout comment capture during order placement
- Order admin display locations controlled by configuration
- Stored order note for customer service, fulfillment, and operations
Requirements And Dependencies
- PHP: >=8.1
- Magento packages: magento/framework, magento/module-backend, magento/module-checkout, magento/module-config, magento/module-quote, magento/module-sales, magento/module-store
- PPL packages: ppl/module-hub
Installation
Composer installation:
composer require ppl/module-order-comment
bin/magento module:enable Ppl_Hub Ppl_OrderComment
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
Manual app/code installation: copy the module to app/code/Ppl/OrderComment, install the dependencies listed above, then run the same Magento commands without the Composer step.
First Use
- Enable the module with Checkout, Quote, Sales, Store, Config, and Ppl_Hub dependencies.
- Configure Enabled, Max Length, and Admin Display Locations.
- Place a test order to confirm the comment is saved and visible.
Admin entry: Stores > Configuration > PPL > Order Comment / Sales order detail.
Integrations And Boundaries
- Works beside reporting and order-management modules but does not require them.
Localization
The package includes translation CSV files for 12 locales: de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, nl_NL, pl_PL, pt_BR, ru_RU, tr_TR, zh_CN.
Documentation
- Screenshot inventory:
docs/images/ppl-order-comment/in the repository documentation tree
Support
Support contact: [email protected]. Include the module version, Magento version, enabled PPL companion modules, and the relevant admin or storefront screenshot when reporting an issue.
Changelog
1.2.0
- Adapted to the updated PPL Hub: admin navigation, ACL, and menu integration aligned to the PPL Hub 1.2 line
- Minor fixes and stability improvements
Unreleased
- Added configurable admin order view display location for Customer Comment.
- Fixed admin order comment layout attachment by targeting Magento's order additional info container.
1.0.0
Initial release.
Features:
- Checkout order comment field
- Quote and sales order persistence through extension attributes
- Admin order view rendering
- Declarative schema for quote and order columns
Requires 12
| Package | Constraint |
|---|---|
| ext-mbstring | * |
| magento/framework | >=103.0.0 <104.0.0 |
| magento/module-backend | >=102.0.0 <103.0.0 |
| magento/module-checkout | >=100.4.0 <101.0.0 |
| magento/module-config | >=101.2.0 <102.0.0 |
| magento/module-quote | >=101.2.0 <102.0.0 |
| magento/module-sales | >=103.0.0 <104.0.0 |
| magento/module-store | >=101.1.0 <102.0.0 |
| magento/module-ui | >=101.0.0 <103.0.0 |
| php | >=8.1 |
| ppl/module-hub | ^1.2 |
| psr/log | ^1.0 || ^2.0 || ^3.0 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from Pawel Pliousnin Digital Solutions
View vendorPPL Dev Tool add-on for creating repeatable Magento 2 development tax classes, rates and rules.
Magento 2 admin development hub for search simulation, generated-data cleanup and optional seed-data add-ons.
PPL Dev Tool add-on for creating repeatable Magento 2 development store setup data and configuration.
PPL Dev Tool add-on for generating repeatable Magento 2 seed orders for reports, QA and demos.
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.