outeredge/magento-base-module

Magento 2 Base Module by outer/edge

5.0.16 2024-11-13 15:52 UTC

Requires

• php: ^8.1
• eliashaeussler/cache-warmup: *
• magento/product-community-edition: >=2.4.4
• outeredge/googlecloudstorage: ^2.0
• outeredge/magento-bulk-actions: ^1.0
• outeredge/magento-language-en_gb-module: ^1.0
• outeredge/magento-layout-module: ^3.4
• outeredge/magento-limitrole-module: ^1.0
• outeredge/magento-opentelemetry-module: ^1.0

Suggests

• outeredge/magento-disable-common: To remove commonly unused modules
• outeredge/magento-disable-graphql: To remove GraphQL modules when not in use

MIT

• outer/edge

README

This module provides the following useful features for Magento 2:

Admin

• Additional widget types
  • Image picker
  • Text field
• Enabled anchor button in WYSIWYG
• Banner images for CMS pages - adds an option to upload a banner image to all page in Content > Pages which can be pulled through to the frontend.
• Create section in admin menu for quick actions:
  • Create new order
  • Create product
• Enforces media URL seen by the admin to be NULL always (i.e. so CDN isn't used)

SEO

• Canonical URL improvements
  • Add canonical URL for all CMS pages
  • Include pagination in category canonical URLs as per Google Recommendation
• Set robots meta tag to NOINDEX/NOFOLLOW for:
  • Common query strings such as list ordering, limit, store codes etc
  • Search results
  • Product review list
• Forces a 404 HTTP response for placeholder images
• Adds preconnect headers for google.com/gstatic.com

Cookiebot & Termly

• Don't move cookiebot tags to footer when move JS to footer is enabled
• Block YouTube cookies unless Cookiebot has given consent (Enabled by default)
• Cookiebot declaration template for use on cookie policy CMS page
• Import Termly generated Cookie Policy for use on cookie policy CMS page

API

• /rest/V1/site_status/get - To remotely obtain recent config changes and indexer statuses

Developer Tools

• Helper classes:
  • Asset helper - get assets
  • Image helper - get media images and resize, crop etc.
  • Config helper - get values from Magento config
• Console commands
  • outeredge:nuke for removing all cache and static files
  • outeredge:config lists all recent config changes
• Adds support for newer version of MariaDB
• Disables jQuery mutate console messages

Console Commands

Cookiebot Declaration

To add the Cookiebot cookie declaration form into your cookie policy CMS page, add the following snippet into the CMS page in the Magento admin:

{{block class="Magento\Framework\View\Element\Template" template="OuterEdge_Base::cookiebot/declaration.phtml"}}

Termly Cookie Policy

To add the Termly cookie policy into your cookie policy CMS page, add the following snippet into the CMS page in the Magento admin:

{{block class="Magento\Framework\View\Element\Template" template="OuterEdge_Base::termly/cookie-policy.phtml"}}

Multistore projects

Add multistore.php to the top of the composer.json autoload/files section to allow separate config files (and thus databases) per store on the same instance/repository:

• Add to composer.json :

    "autoload": {
        "files": [
            "vendor/outeredge/magento-base-module/multistore.php",
            ...

• Then create individual env.php files for each, naming them env.php.STORE_CODE replacing STORE_CODE as applicable.