PHPackages hk2/core - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. hk2/core ActiveMagento2-module[Utility & Helpers](/categories/utility) hk2/core ======== HK2 Core module - The foundational base module for all Magento 2 HK2 extensions. v1.0.0(1mo ago)0346OSL-3.0ShellPHP ^8.1 || ^8.2 || ^8.3 || ^8.4CI passing Since Jul 16Pushed 1mo agoCompare [ Source](https://github.com/basantmandal/magento2-hk2-core-module)[ Packagist](https://packagist.org/packages/hk2/core)[ RSS](/packages/hk2-core/feed)WikiDiscussions main Synced 1w ago READMEChangelog (5)Dependencies (3)Versions (5)Used By (6) HK2 Core ======== [](#hk2-core) [![Version](https://camo.githubusercontent.com/237d1acda4e6382632732014a4c334bea6c05fba318dec7bf7d3fa9cf8610aee/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e312e302d626c75653f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/237d1acda4e6382632732014a4c334bea6c05fba318dec7bf7d3fa9cf8610aee/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e312e302d626c75653f7374796c653d666c61742d737175617265)[![License](https://camo.githubusercontent.com/a3fd2257982f64afbde00a66a8ab5984ee3f6e176f00eb2ec4ea61d862bc113b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4f534c2d2d332e302d677265656e3f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/a3fd2257982f64afbde00a66a8ab5984ee3f6e176f00eb2ec4ea61d862bc113b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4f534c2d2d332e302d677265656e3f7374796c653d666c61742d737175617265)[![Magento](https://camo.githubusercontent.com/5c0e69cb7da2670c8c31d9baa7de3bb6e955ec4847f236b0c025d24cd587ac54/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322e342e342d2d322e342e392d6639373331363f7374796c653d666c61742d737175617265266c6f676f3d6d6167656e746f266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/5c0e69cb7da2670c8c31d9baa7de3bb6e955ec4847f236b0c025d24cd587ac54/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322e342e342d2d322e342e392d6639373331363f7374796c653d666c61742d737175617265266c6f676f3d6d6167656e746f266c6f676f436f6c6f723d7768697465)[![PHP](https://camo.githubusercontent.com/ad4f93eecb5fbaab9df06144c39ec979001e451fe5c303f11692bf6ba2aa14b8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e31253230253743253743253230382e32253230253743253743253230382e33253230253743253743253230382e342d3763336165643f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/ad4f93eecb5fbaab9df06144c39ec979001e451fe5c303f11692bf6ba2aa14b8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e31253230253743253743253230382e32253230253743253743253230382e33253230253743253743253230382e342d3763336165643f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465)[![Downloads](https://camo.githubusercontent.com/7d7beacbcd391f79c82b7e8360c7b57e0909431954d370e4dee9b54d7432a746/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f686b322f636f72653f7374796c653d666c61742d737175617265)](https://packagist.org/packages/hk2/core) Overview -------- [](#overview) The HK2 Core module is the foundational base module for all Magento 2 HK2 extensions. It establishes standard administrative configurations, reusable backend blocks, and standardized headers for module configuration screens. ๐ŸŽฏ Use Cases ----------- [](#-use-cases) - **Module Base**: Required by all other HK2 extensions (AddBootstrap5, CSP, ScrollTop, etc.) to function correctly. - **Admin Consolidation**: Consolidates HK2 module configurations into a single, organized tab in the Magento Admin Panel. ๐Ÿš€ Features ---------- [](#-features) - โš™๏ธ Registers a centralized "HK2 Extensions" configuration tab. - ๐Ÿ“‚ Sets up a main admin menu item under System for HK2. - ๐Ÿ”’ Implements a root ACL resource for all HK2 modules. - ๐ŸŽจ Provides a reusable `ModuleHeader` block for consistent branding. ๐Ÿ— Architecture -------------- [](#-architecture) - **Core Module Components**: Base adminhtml system configurations. - **Design Patterns**: Standard Magento UI configuration implementations. ๐Ÿงฉ Magento Components -------------------- [](#-magento-components) ### Blocks [](#blocks) - `HK2\Core\Block\Adminhtml\System\Config\ModuleHeader` ### Layout XML [](#layout-xml) - `HK2_Core::system/config/module_header.phtml` ๐Ÿ“ฆ Requirements -------------- [](#-requirements) - **Magento version**: 2.4.4 - 2.4.9 - **PHP requirements**: 8.1 || 8.2 || 8.3 || 8.4 - **Composer requirements**: `magento/framework: ^103.0.0` โš™๏ธ Installation --------------- [](#๏ธ-installation) 1. `composer require hk2/core` 2. `bin/magento module:enable HK2_Core` 3. `bin/magento setup:upgrade` 4. `bin/magento setup:di:compile` 5. `bin/magento cache:flush` ๐Ÿ”ง Configuration --------------- [](#-configuration) This module primarily provides configuration tabs for other modules. No specific configuration is required for the Core module itself. Usage ----- [](#usage) This module works silently in the background. Once installed, navigating to **Stores > Configuration** will display a new "HK2" tab where dependent modules will render their settings. ๐Ÿ—„ Database Changes ------------------ [](#-database-changes) Not Applicable ๐Ÿ“‚ Module Structure ------------------ [](#-module-structure) ``` Block/ โ”œโ”€โ”€ Adminhtml/ โ”‚ โ””โ”€โ”€ System/ โ”‚ โ””โ”€โ”€ Config/ โ”‚ โ””โ”€โ”€ ModuleHeader.php etc/ โ”œโ”€โ”€ adminhtml/ โ”‚ โ”œโ”€โ”€ menu.xml โ”‚ โ””โ”€โ”€ system.xml โ”œโ”€โ”€ acl.xml โ””โ”€โ”€ module.xml view/ โ””โ”€โ”€ adminhtml/ โ””โ”€โ”€ templates/ โ””โ”€โ”€ system/ โ””โ”€โ”€ config/ โ””โ”€โ”€ module_header.phtml ``` ๐Ÿงช Testing --------- [](#-testing) Not Applicable ๐Ÿ“ˆ Performance Considerations ---------------------------- [](#-performance-considerations) Not Applicable ๐Ÿ” Security Considerations ------------------------- [](#-security-considerations) - **ACL usage**: Defines `HK2_Core::root` base ACL for administrative access to HK2 configurations. Compatibility ------------- [](#compatibility) Reference: [docs/compatibility.md](docs/compatibility.md) PlatformSupported VersionsMagento2.4.4 - 2.4.9PHP8.1, 8.2, 8.3, 8.4๐Ÿ”„ Upgrade Notes --------------- [](#-upgrade-notes) Not Applicable ๐Ÿ›  Troubleshooting ----------------- [](#-troubleshooting) If HK2 tabs do not appear in the admin panel, ensure that the cache has been flushed and `HK2_Core` is enabled using `bin/magento module:status`. ๐Ÿค Contributing -------------- [](#-contributing) Contributions are welcome! If you'd like to improve the installer: - โญ **Star this repository** (Helps others find it!) - ๐Ÿด Fork the project - ๐Ÿ› Report bugs - ๐Ÿ’ก Suggest new features - ๐Ÿค Contribute improvements Every โญ helps increase the visibility of the project and motivates further development. โš–๏ธ Disclaimer ------------- [](#๏ธ-disclaimer) The author provides this installation script "as is" without any warranties. Users are responsible for ensuring that running this script complies with their internal security and software requirements. --- ๐Ÿค Support --------- [](#-support) For bug reports, feature requests, and general support: - **Author**: Basant Mandal - **Email**: - **Website**: License ------- [](#license) This project is licensed under the OSL 3.0 License. See the [LICENSE.txt](LICENSE.txt) file for details. --- ### Health Score 45 โ€” FairBetter than 91% of packages Maintenance94 Actively maintained with recent releases Popularity11 Limited adoption so far Community16 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 90% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~56 days Total 4 Last Release 32d ago PHP version history (2 changes)1.0.0PHP ^8.1 || ^8.2 1.0.2PHP ^8.1 || ^8.2 || ^8.3 || ^8.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/ffa270f1557c4c55c55fec1ad6f2544170980c8dd7f679c10582a3736f7d3a4c?d=identicon)[basantmandal](/maintainers/basantmandal) --- Top Contributors [![basantmandal](https://avatars.githubusercontent.com/u/69835601?v=4)](https://github.com/basantmandal "basantmandal (9 commits)")[![semantic-release-bot](https://avatars.githubusercontent.com/u/32174276?v=4)](https://github.com/semantic-release-bot "semantic-release-bot (1 commits)") --- Tags hk2magento2-modulecoremagento2HK2Basantmagento modulebasantmandal ### Embed Badge ![Health badge](/badges/hk2-core/health.svg) ``` [![Health](https://phpackages.com/badges/hk2-core/health.svg)](https://phpackages.com/packages/hk2-core) ``` ### Alternatives [run-as-root/magento2-prometheus-exporter Magento2 Prometheus Exporter 69362.0k](/packages/run-as-root-magento2-prometheus-exporter)[myparcelnl/magento A Magento 2 module that creates MyParcel labels 1861.2k](/packages/myparcelnl-magento)[smile/module-store-locator Smile Store Locator 51537.6k5](/packages/smile-module-store-locator)[angeo/module-llms-txt Magento 2 module for AI Engine Optimization (AEO). Generates spec-compliant llms.txt and llms-full.txt per llmstxt.org standard, plus streaming JSONL for vector indexing. Multi-store, multi-website, CLI, cron, async admin UI, Page Builder-aware sanitization, customer-group pricing, atomic writes, ETag/Cache-Control, .md mirrors. 132.2k](/packages/angeo-module-llms-txt)[mage-os/module-llm-txt AI-powered LLMs.txt generation for Magento 2 / Mage-OS stores. Help AI systems understand your store with OpenAI-generated content. 245.7k](/packages/mage-os-module-llm-txt)[loki/magento2-components Core module for defining Alpine.js components with advanced AJAX features 1015.1k29](/packages/loki-magento2-components) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)