PHPackages                             fooman/essentialcatalog-m2 - 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. fooman/essentialcatalog-m2

AbandonedArchivedMetapackage

fooman/essentialcatalog-m2
==========================

Set non-essential products out of stock for your Magento 2.3+ store

1.0.0(6y ago)315OSL-3.0PHP ~7.1.3|~7.2.0|~7.3.0

Since Apr 3Pushed 10mo agoCompare

[ Source](https://github.com/fooman/essentialcatalog-m2)[ Packagist](https://packagist.org/packages/fooman/essentialcatalog-m2)[ RSS](/packages/fooman-essentialcatalog-m2/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (2)Versions (2)Used By (0)

Fooman EssentialCatalog
=======================

[](#fooman-essentialcatalog)

Extension for Magento 2.3+
--------------------------

[](#extension-for-magento-23)

The motivation behind this extension is the latest update to online trading regulations in New Zealand in response to the COVID-19 pandemic. As per the [government website](https://www.mbie.govt.nz/about/open-government-and-official-information/coronavirus-covid-19/essential-services/) as of 2020-04-03:

> 1. Orders must be taken online or by phone only. Storefronts must not be open and the public should not be able to visit stores to select or collect goods.
> 2. Orders must be for only essential non-food consumer products. In fulfilling orders, businesses must take all appropriate public health measures (e.g. physical distancing, hygiene basics, appropriate personal protective equipment for staff).
> 3. Orders must be home delivered in a contactless way (i.e. there is no physical interaction between the deliverer and customer).
> 4. The business must inform MBIE of its intention to offer essential non-food products for sale, and provide a list of the products they intend to offer.

This extension adds the ability to classify a product as an Essential Product. And once enabled all simple, configurable or bundle products that aren't set as essential products would be out of stock products.

Installation Instructions
-------------------------

[](#installation-instructions)

### Easy option using the ExtDN Installer

[](#easy-option-using-the-extdn-installer)

Copy and paste the below command into the command line in your Magento root folder. The installation will proceed automatically from there:

```
sh -ic "$(curl -sS https://raw.githubusercontent.com/extdn/installer-m2/master/bin/oneliner.sh)" -- install fooman/essentialcatalog-m2:^1.0

```

### You install extensions all the time

[](#you-install-extensions-all-the-time)

This package is available via packagist.org. Please use Composer to install the extension

```
bin/magento deploy:mode:set developer (if you are in production mode)
composer require fooman/essentialcatalog-m2:^1.0
bin/magento module:enable --clear-static-content Fooman_EssentialCatalog
bin/magento setup:upgrade

your usual sequence of commands to enable production mode, for example
bin/magento deploy:mode:set production

```

How to use
----------

[](#how-to-use)

Enable the setting "Restrict Catalog to Essential Products" under Stores > Configuration [![Stores > Configuration](docs/stores-configuration.png?raw=true%22)](docs/stores-configuration.png?raw=true%22)

Catalog > Inventory > Product Stock Options [![Restrict Catalog to Essential Products](docs/enable-restricted-catalog.png?raw=true%22)](docs/enable-restricted-catalog.png?raw=true%22)The Magento Cache would need to get refreshed after making a change.

Then set the product as essential or not. The value "Use Config" would indicate no decision yet applied and the product would not change it's stock status. Details on what is deemed essential or not (for New Zealand) can also be found on this [page](https://www.mbie.govt.nz/about/open-government-and-official-information/coronavirus-covid-19/essential-services/). [![Essential Products](docs/essential-product.png?raw=true%22)](docs/essential-product.png?raw=true%22)

Alternatively you may wish to export and then re-import your complete catalog to a csv file and set the attribute `fooman_is_product_essential` to

- 0 for not essential
- 1 for essential

Note
----

[](#note)

This extension hooks into functionality provided by Magento Inventory aka MSI.

Developer Note - Depending on EssentialCatalog
----------------------------------------------

[](#developer-note---depending-on-essentialcatalog)

If you are using EssentialCatalog to build functionality on top of please require the implementation package `composer require essentialcatalog-implementation-m2` instead as only that package will be semantically versioned.

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance41

Moderate activity, may be stable

Popularity9

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

2227d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/375f14d0764181d464de53f75008cf58c61f6c348e2649a9700699612a7ede65?d=identicon)[fooman](/maintainers/fooman)

---

Top Contributors

[![kristof-ringleff](https://avatars.githubusercontent.com/u/47804013?v=4)](https://github.com/kristof-ringleff "kristof-ringleff (7 commits)")

### Embed Badge

![Health badge](/badges/fooman-essentialcatalog-m2/health.svg)

```
[![Health](https://phpackages.com/badges/fooman-essentialcatalog-m2/health.svg)](https://phpackages.com/packages/fooman-essentialcatalog-m2)
```

###  Alternatives

[fastly/magento2

Fastly CDN Module for Magento 2.4.x

1564.2M1](/packages/fastly-magento2)[mage-os/module-automatic-translation

Automatic AI content translation for Mage-OS.

277.1k](/packages/mage-os-module-automatic-translation)[zepgram/module-rest

Technical module to industrialize API REST call with dependency injection pattern using Guzzle library

1326.2k](/packages/zepgram-module-rest)[graycore/magento2-graphql-introspection-cache

1015.2k](/packages/graycore-magento2-graphql-introspection-cache)[mage-os/mageos-common-async-events

Send REST requests to external endpoints asynchronously. This module implements the most common events like order creation and customer change.

147.7k2](/packages/mage-os-mageos-common-async-events)[mage-os/module-inventory-reservations-grid

Add a grid with the list of inventory reservations.

126.8k](/packages/mage-os-module-inventory-reservations-grid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)