PHPackages                             bitpolar/categoryimgwidget - 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. bitpolar/categoryimgwidget

ActiveMagento2-module

bitpolar/categoryimgwidget
==========================

Magento2 Category List Widget with optional thumbnails

1.1.0(6y ago)099OSL-3.0PHPPHP ~7.1.3||~7.2.0

Since May 24Pushed 6y agoCompare

[ Source](https://github.com/Bitpolar-Tech/magento2-category-list-with-thumbnail-widget)[ Packagist](https://packagist.org/packages/bitpolar/categoryimgwidget)[ RSS](/packages/bitpolar-categoryimgwidget/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)DependenciesVersions (7)Used By (0)

Magento 2 Widget: Category List with optional thumbnail or category image
=========================================================================

[](#magento-2-widget-category-list-with-optional-thumbnail-or-category-image)

Based on

\#Features

- Add category list as a widget
- Manage Image Size Output
- Assign Custom Parent Category
- Or list any category
- Add and use additional thumbnail as preview image
- Images are resized and cached to the user defined sizes
- Uses the placeholder image as default

Composer Installation Instructions
----------------------------------

[](#composer-installation-instructions)

```
  composer require bitpolar/categoryimgwidget
```

###  Enable Bitpolar/CategoryImgWidget Module

[](#-enable-bitpolarcategoryimgwidget-module)

to Enable this module you need to follow these steps: - **Enable the Module**```
    bin/magento module:enable Bitpolar_CategoryImgWidget
    ```
- **Run Upgrade Setup**```
    bin/magento setup:upgrade
    ```
- **Re-Compile (in-case you have compilation enabled)** ```
    bin/magento setup:di:compile
    ```

#### How to add new category image ?

[](#how-to-add-new-category-image-)

The module already creates one image field called **Thumbnail**.

If you need to additional image fields follow these steps:

1. Create an upgrade data script to create the new category image attribute.
2. Create new upload class for the new image attribute by copy-pasting the file **Controller/Adminhtml/Category/Thumbnail/Upload.php**. Change the class name and the following line:

```
  $result = $this->imageUploader->saveFileToTmpDir('{image-attribute-code}');
```

3. Add the new fields to the admin html category form at **view/adminhtml/ui\_component/category\_form.xml** and change: the field name, the label and the uploader Url

```

                    string
                    category
                    {Image Label}
                    true
                    fileUploader
                    ui/form/element/uploader/uploader
                    Magento_Catalog/image-preview
                    false
                    41

```

4. Add the new image attribute code to the helper class **Helper/Category.php** line 16

```
public function getAdditionalImageTypes()
    {
        return array('thumbnail', '{image-attribute-code}');
    }
```

5. Repeat step 4 in the Controller class **Controller/Adminhtml/Category/Save.php** line 18

```
protected function getAdditionalImages() {
        return array('thumbnail', '{image-attribute-code}');
}
```

If everything went well you should be able to see the new field on the category screen under the **Content** group. You should also be able to upload, save and delete the image file successfully.

#### How to show the new image on frontend ?

[](#how-to-show-the-new-image-on-frontend-)

The module comes with a block that can print any new image field on the category page frontend. Just add the following XML block under the container/block you would like the image to appear.

```

        {image-attribute-code}
        {div-css-class}

```

The above block can print category images ONLY on category pages cause it assumes there is already stored category model in core registry. If you need to print the image on other pages use the following code snippet.

```
$category = 'load a category model class here'; // the decision how to load category model object is up to you.
$helper    = $this->helper('Bitpolar\CategoryImgWidget\Helper\Category');
$imageUrl = $helper->getImageUrl($category->getData('image-attribute-code'));
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~239 days

Recently: every ~37 days

Total

6

Last Release

2447d ago

PHP version history (2 changes)1.0.0PHP ~5.5.0|~5.6.0|~7.0.0

1.0.1PHP ~7.1.3||~7.2.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/7f9f93cfb3317d9171801c258951afc61d53443925c4d29af49bfdc7adb83f6b?d=identicon)[bitpolar](/maintainers/bitpolar)

---

Top Contributors

[![lingwooc](https://avatars.githubusercontent.com/u/9419862?v=4)](https://github.com/lingwooc "lingwooc (10 commits)")[![Stefan0x](https://avatars.githubusercontent.com/u/696665?v=4)](https://github.com/Stefan0x "Stefan0x (10 commits)")[![nicolas-medina](https://avatars.githubusercontent.com/u/48969057?v=4)](https://github.com/nicolas-medina "nicolas-medina (9 commits)")[![emizentech](https://avatars.githubusercontent.com/u/6728729?v=4)](https://github.com/emizentech "emizentech (8 commits)")[![kovinet](https://avatars.githubusercontent.com/u/707846?v=4)](https://github.com/kovinet "kovinet (1 commits)")[![pynej](https://avatars.githubusercontent.com/u/458367?v=4)](https://github.com/pynej "pynej (1 commits)")

### Embed Badge

![Health badge](/badges/bitpolar-categoryimgwidget/health.svg)

```
[![Health](https://phpackages.com/badges/bitpolar-categoryimgwidget/health.svg)](https://phpackages.com/packages/bitpolar-categoryimgwidget)
```

PHPackages © 2026

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