PHPackages                             vaersaagod/matrixmate - 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. vaersaagod/matrixmate

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

vaersaagod/matrixmate
=====================

Welding Matrix into shape, mate!

2.2.2(1y ago)44261.5k↑12.5%9[1 PRs](https://github.com/vaersaagod/matrixmate/pulls)3MITPHPPHP ^8.0.2

Since Apr 26Pushed 9mo ago3 watchersCompare

[ Source](https://github.com/vaersaagod/matrixmate)[ Packagist](https://packagist.org/packages/vaersaagod/matrixmate)[ RSS](/packages/vaersaagod-matrixmate/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (43)Used By (3)

MatrixMate plugin for Craft CMS
===============================

[](#matrixmate-plugin-for-craft-cms)

Welding Matrix into shape, mate!

[![Screenshot](resources/img/plugin-logo.png)](resources/img/plugin-logo.png)

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 4.0.0 or later.

‼️MatrixMate has been retired and will not be available for Craft 5. See [this issue](https://github.com/vaersaagod/matrixmate/issues/72) for more info.
Also see [this comment](https://github.com/vaersaagod/matrixmate/issues/77#issuecomment-3163280016) for some hints and tips towards migrating away from MatrixMate 🚀

Installation
------------

[](#installation)

To install the plugin, either install it from the plugin store, or follow these instructions:

1. Install with composer via `composer require vaersaagod/matrixmate` from your project directory.
2. Install the plugin in the Craft Control Panel under Settings -> Plugins, or from the command line via `./craft plugin/install matrixmate`.
3. For MatrixMate to do anything, you need to [configure it](#configuring-matrixmate). But first, continue reading!

---

MatrixMate overview
-------------------

[](#matrixmate-overview)

MatrixMate enables you to improve the Matrix authoring experience by sorting block types into *groups* and block type fields into *tabs*.

Additionally, MatrixMate offers these nifty features:

- Maximum limits can be set per block type
- Ungrouped block types can be hidden, or displayed as native Matrix buttons
- A single block type can be added to multiple groups (sometimes it makes sense!)
- Block types can be explicitly hidden, even without using the grouping feature
- A single Matrix field can be configured differently for different contexts (e.g. sections, entry types, category groups etc)

[![alt text](resources/img/screenshot.png "Plugin screenshot")](resources/img/screenshot.png)

### I can't believe it's not Pimp My Matrix!

[](#i-cant-believe-its-not-pimp-my-matrix)

MatrixMate began life as a fork of famed Craft plugin [Pimp My Matrix](https://github.com/angell-co/Pimp-My-Matrix/) (aka [Spoon](https://github.com/angell-co/Spoon) for Craft 3), and we give big props to its author [Josh Angell](https://github.com/angell-co) for inspiring MatrixMate.

The featureset overlap between Spoon and MatrixMate is pretty obvious, but a big difference is that unlike Spoon, MatrixMate does *not* feature a field configuration UI inside Craft's Control Panel. Instead, MatrixMate is completely configured using a PHP config file.

[Read more about configuring MatrixMate here](#configuring-matrixmate)

### Nested Matrix fields

[](#nested-matrix-fields)

MatrixMate does *not* support Matrix fields that are nested in other fieldtypes (e.g. SuperTable). If you need SuperTable support, you should consider using [Spoon](https://github.com/angell-co/Spoon) instead.

---

Configuring MatrixMate
----------------------

[](#configuring-matrixmate)

MatrixMate is configured by creating a config file named `matrixmate.php` in your Craft config folder (i.e. where your `general.php` and `db.php` files sit).

The config file should look something like this:

```