Download the PHP package hryvinskyi/magento2-head-tag-manager without Composer

Adobe Commerce / Magento 2 Head Tag Manager Module

This module provides a robust solution for managing HTML head elements in Adobe Commerce / Magento 2 applications. This module allows you to dynamically add, modify, and render various HTML head elements like meta tags, stylesheets, scripts, and other elements.

Features:

• CSP Compatible: Full support for Magento Content Security Policy
• Performance Optimized: Efficient element management and rendering

Key Features

• Add preconnect and prefetch links
• Add link elements (stylesheets, canonical, etc.)
• Add inline and external scripts with CSP support
• Add inline styles with CSP support

Installation

Composer Installation

Manual Installation

1. Create directory app/code/Hryvinskyi/HeadTagManager
2. Download and extract module contents to this directory
3. Enable the module:

Usage

Via ViewModel

Architecture

Cache Strategy

This module is not recommended for use on cached blocks, but this module provides a cache-aware architecture to handle head elements on cached blocks, and correctly render them.

Common Methods

• addMetaName(string $name, string $content, ?string $key = null) - Add meta tag with name attribute
• addMetaProperty(string $property, string $content, ?string $key = null) - Add meta tag with property attribute
• addCharset(string $charset = 'UTF-8') - Add charset meta tag
• addStylesheet(string $href, array $attributes = [], ?string $key = null) - Add stylesheet link
• addInlineStyle(string $content, array $attributes = [], ?string $key = null) - Add inline style
• addExternalScript(string $src, array $attributes = [], ?string $key = null) - Add external script
• addInlineScript(string $content, array $attributes = [], ?string $key = null) - Add inline script

Element Sort Order

You can control the rendering order of head elements using the sort_order parameter. Elements are sorted in ascending order (lower values render first). The default sort order is 100 for all elements.

Elements with the same sort order maintain their insertion order (stable sort).

Advanced Usage

Custom Elements

To add support for a new head element type:

1. Create Element Class: Implement HeadElementInterface
2. Create Factory: Extend AbstractHeadElementFactory
3. Create Strategy: Implement HeadElementSerializationStrategyInterface
4. Register via DI: Add to di.xml configuration

Example Custom Element

Custom Factory

Custom Serialization Strategy

Custom Factory Registration

To register your custom element and factory, add the following to your di.xml:

Usage

To use your custom element, simply call the factory from the HeadTagManager:

Element Serialization

Custom serialization strategies allow for element-specific handling:

Integration

The module automatically injects head elements at the <!-- {{HRYVINSKYI:PLACEHOLDER:HEAD_ADDITIONAL}} --> placeholder in your HTML output.

Version History

See CHANGELOG.md for detailed version history and migration notes.

Testing

The module includes comprehensive test coverage:

• Unit Tests: All core classes and interfaces
• Integration Tests: End-to-end functionality
• Cache Tests: Cache-aware functionality

Run tests with:

Contributing

Contributions are welcome! Please ensure:

• All tests pass
• New features include tests
• Code follows SOLID principles
• Documentation is updated

License

Copyright © 2025 Volodymyr Hryvinskyi. All rights reserved.