Search
My Cart

boldcommerce / magento2-ordercomments

boldcommerce/magento2-ordercomments

Magento 2 Module to add a comment field above the place order button in the checkout

  • Bold Commerce BV
magento2-module Compatibility: Partially compatible Code Quality: Fail Tests: N/A Security: Pass MIT

Are you the maintainer of boldcommerce?

Packagento pulls boldcommerce's Composer packages from the public registry so buyers can find them here.

Claim the namespace to take ownership, publish new releases directly, and start charging for premium versions.

Claim this namespace →

Bold Commerce: Magento 2 Order Comments

Description

This extension allows customers to place a comment during the checkout.
The comment field is displayed in the billing step right above the place order button.

Additionally, there is also the option of showing the comment field on the cart page.

Store owners can then see these comments in the backend on the order grid and on the order view page.

Checkout view

[image: comment box closed]

[image: comment box opened]

Admin panel

[image: admin panel]

Emails

Add the "order comment" to new order emails by referencing the code here.

Configuration

There are several configuration options for this extension, which can be found at STORES > Configuration > SALES > Sales > Order Comments.

Installation

composer require boldcommerce/magento2-ordercomments
php bin/magento module:enable Bold_OrderComment
php bin/magento setup:upgrade

Changelog

1.8.5

  • Third party contribution: PHP 8.1 bugfix Deprecated Functionality: trim(): Passing null to parameter when viewing
    an order in the my orders section that doesn't have an order comment #72

1.8.4

  • Third party contribution: PHP 8.1 support #71
  • Third party contribution: Spanish translations #70
  • Third party contribution: Thai translations #67

1.8.2

  • Third party contribution: Bengali translations #65

1.8.1

  • fix bug introduced with 1.8.0 in checkout Cannot read property 'length' of null

1.8.0

  • new feature: ability to show the comment field on the cart page based on a admin configuration setting.

1.7.1

  • upgrade tests to phpunit 6

1.7.0

  • Added website scope configuration setting to toggle visibility of comment field. #59

1.6.5

  • Third party contribution: PHP 7.4 support added in composer #55
  • Third party contribution: Japanese translations added #52
  • Third party contribution: Fix typo in Italian translation #51
  • Third party contribution: Hungarian Translations added #50
  • Third party contribution: New sections added in readme #48

1.6.4

  • Third party contribution: php 7.3 support in composer #45
  • Third party contribution: French translations #43
  • Third party contribution: Polish translations #40
  • Third party contribution: Czech translations #39

1.6.3

  • Third party contribution: move form selector in order-comment-validator.js to a separate method to improve extensibility through mixins #36

1.6.2

  • Third party contribution: fix duplicate comment field on admin sales invoice view #31
  • Third party contribution: fix typo and added some code improvements to the install script #30

1.6.1

  • Third party contribution: Enabled PHP 7.2 support #29

1.6.0

  • Third party contribution: Hebrew translations #28

1.5.0

  • Third party contribution: Form selector fallback for compatability with external changes that move the comment field #24

1.4.1

  • Third party contribution: Fixed it_IT translation csv #20

1.4.0

  • Third party contribution: Made the comment available in the order list web api V1/orders #18

1.3.0

  • UX changes to the max comment length feature #15
  • Made the comment available in the order detail web api V1/orders/{id} #15

1.2.0

  • added setting to change initial collapse state of comment field (closed/opened/no collapse) #14

1.1.4

  • updated composer.json to allow PHP 7.1

1.1.3

  • Third party contribution: Dutch translations #10
  • Third party contribution: Italian translations #11

1.1.2

  • Fix for fatal error on admin order view page when used with some other extensions #9

1.1.1

  • Third party contribution: Swedish translations and fixes in German translations #5

1.1.0

  • Third party contribution: German translations #2
  • Third party contribution: Optional configuration for maximum comment length #3
  • Third party contribution: Show order comments in customer account #4

1.0.0

initial version

Technical

To take in account third party payment extensions using custom implementations of Magento_Checkout/js/action/place-order.js to submit the order, this extension sends
the order comment in a separate request during the validation, before the order is placed. It should therefore work out of
the box.

Uninstall

If you installed this module through composer, then you can run php bin/magento module:uninstall Bold_OrderComment to automatically
remove the code and drop the columns added by this extension.

note: the uninstall command seems bugged and might get stuck at Removing code from Magento codebase: (It worked fine for me on a 2.1.0 install but not on a 2.1.4 install). When this happens you should
exit with ctrl+c and run

composer update
php bin/magento maintenance:disable

See github issue 3544

Alternatively you can manually remove the extension and remove the column bold_order_comment from the tables

  • quote
  • sales_order
  • sales_order_grid

License

MIT

No changelog yet

The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.

Versions
Version Stability QA Status Compatibility Released
1.9.0 stable Fail Partially compatible Details 2023-05-17 11:43:52
1.8.5 stable Not tested Not yet tested Details 2022-08-06 10:43:17
1.8.4 stable Not tested Not yet tested Details 2022-08-05 16:36:29
1.8.3 stable Not tested Not yet tested Details 2021-08-25 09:56:40
1.8.2 stable Not tested Not yet tested Details 2021-04-30 17:33:24
1.8.1 stable Not tested Not yet tested Details 2020-12-14 11:24:43
1.8.0 stable Not tested Not yet tested Details 2020-12-10 15:54:25
1.7.1 stable Not tested Not yet tested Details 2020-11-05 16:00:57
1.7.0 stable Not tested Not yet tested Details 2020-10-15 14:27:42
1.6.5 stable Not tested Not yet tested Details 2020-10-15 13:14:02
1.6.4 stable Not tested Not yet tested Details 2019-10-11 15:18:10
1.6.3 stable Not tested Not yet tested Details 2019-04-03 08:23:32
1.6.2 stable Not tested Not yet tested Details 2019-01-14 16:48:51
1.6.1 stable Not tested Not yet tested Details 2018-12-11 09:44:49
1.6.0 stable Not tested Not yet tested Details 2018-11-16 11:23:46
1.5.0 stable Not tested Not yet tested Details 2018-07-09 08:05:00
1.4.1 stable Not tested Not yet tested Details 2018-04-17 07:41:23
1.4.0 stable Not tested Not yet tested Details 2018-04-10 17:58:24
1.3.0 stable Not tested Not yet tested Details 2018-03-02 10:58:36
1.2.0 stable Not tested Not yet tested Details 2017-11-30 16:50:38
1.1.4 stable Not tested Not yet tested Details 2017-11-27 18:00:31
1.1.3 stable Not tested Not yet tested Details 2017-11-20 09:05:19
1.1.2 stable Not tested Not yet tested Details 2017-10-31 10:10:36
1.1.1 stable Not tested Not yet tested Details 2017-09-11 12:53:07
1.1.0 stable Not tested Not yet tested Details 2017-07-07 14:30:37
1.0.1 stable Not tested Not yet tested Details 2017-03-03 09:52:42
1.0.0 stable Not tested Not yet tested Details 2017-03-03 09:25:45

Requires 1

Package Constraint
php ^7.0.0|^8.0.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.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 not tested Pass
2.4.8 not tested not tested
2.4.9 not tested not tested

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.

Static analysis results
Tool Status Findings Summary
PHPCS Fail 55 4 errors, 51 warnings (ruleset: Magento2) — 18 auto-fixable with phpcbf
PHPMD Warning 7 7 rule violations (UnusedFormalParameter:4, MissingImport:2, IfStatementAssignment:1)
Cpd Pass 0
Composer validate Pass 0

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.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 7 7
2.4.8 7 7
2.4.9 7 7

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

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A not tested
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.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
MIT
Authors
Make it pay

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.

List your module