PHPackages                             plasticstudio/iconfield - 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. plasticstudio/iconfield

ActiveSilverstripe-vendormodule[Utility & Helpers](/categories/utility)

plasticstudio/iconfield
=======================

Icon field for Silverstripe - forked from jaedb/iconfield

3.0.2(1mo ago)113.7k↓29.2%5[1 PRs](https://github.com/PlasticStudio/IconField/pulls)BSD-3-ClausePHP

Since Feb 22Pushed 1mo agoCompare

[ Source](https://github.com/PlasticStudio/IconField)[ Packagist](https://packagist.org/packages/plasticstudio/iconfield)[ Docs](http://psdigital.co.nz/)[ RSS](/packages/plasticstudio-iconfield/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (26)Used By (0)

Install
=======

[](#install)

`composer require plasticstudio/iconfield`

Description
===========

[](#description)

Provides a visual icon picker for content authors. Icon files are managable via the asset library.

[![IconField](https://raw.githubusercontent.com/PlasticStudio/IconField/master/screenshot.jpg)](https://raw.githubusercontent.com/PlasticStudio/IconField/master/screenshot.jpg)

Requirements
============

[](#requirements)

- SilverStripe 4, 5 or 6

Version
=======

[](#version)

- Use release 1 for legacy non-cms editable icon files
- Use release 2 for Silverstripe 5 with updated icon files managed in CMS Files area
- Use release 3 for Silverstripe 6

Migration
=========

[](#migration)

If migrating from release 1 to 2/3:

- check if svgs are allowed in mimetypes (guru: )
- upgrade to v2/3
- create new folders in CMS Files area based on IconField set up, eg `SiteIcons` (or reload cms page with iconfield to create). Can have nested folders inside SiteIcons.
- upload and publish icons
- update IconFields to use new source path, eg `IconField::create('SocialIcon', 'Icon', 'SiteIcons')`. You should see relevant icons display in iconfield.
- to update database and relink selected icon: run task `IconFieldPathMigrator_BuildTask` for each class that has been updated
- make sure to add params `?classname=Skeletor\DataObjects\SummaryPanel&field=SVGIcon`
- if your new folder is not 'SiteIcons', add this to the params as well, eg `&new-path=NewFolder`
- lastly, remove the icon folder from client/assets

Usage
=====

[](#usage)

- Import the required classes:

```
use PlasticStudio\IconField\Icon;
use PlasticStudio\IconField\IconField;

```

- Set your `$db` field to type `Icon` (eg `'PageIcon' => Icon::class`)
- `IconField::create($name, $title, $folderName)`

    - `$name` is the database field as defined in your class
    - `$title` is the label for this field
    - `$folderName` is the name of the folder inside the Assets eg 'SiteIcons', nested folders are allowed eg 'SiteIcons/ProductIcons'
- Use your icon in templates as you would any other property (eg `$PageIcon`). If your icon is an SVG, the SVG image data will be injected into the template. To prevent this, you can call `$PageIcon.IMG` instead to enforce use of `` tags.
- Add a default width and height to the config.yml file to output width/height attributes on image tags, e.g. ``. This is good for SEO.

```
PlasticStudio\IconField\IconField:
  default_width: "30"
  default_height: "30"

```

###  Health Score

55

—

FairBetter than 98% of packages

Maintenance89

Actively maintained with recent releases

Popularity30

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor1

Top contributor holds 61.5% 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 ~128 days

Recently: every ~38 days

Total

24

Last Release

55d ago

Major Versions

1.4.1 → 2.0.02025-02-28

1.5.0 → 2.1.12025-10-24

2.2.0 → 3.0.02026-01-22

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/4179876?v=4)[PS/digital](/maintainers/plasticstudio)[@PlasticStudio](https://github.com/PlasticStudio)

---

Top Contributors

[![ebakernz](https://avatars.githubusercontent.com/u/4185091?v=4)](https://github.com/ebakernz "ebakernz (48 commits)")[![monkeyfeet](https://avatars.githubusercontent.com/u/4185129?v=4)](https://github.com/monkeyfeet "monkeyfeet (10 commits)")[![jaedb](https://avatars.githubusercontent.com/u/1711444?v=4)](https://github.com/jaedb "jaedb (10 commits)")[![josephlewisnz](https://avatars.githubusercontent.com/u/57464168?v=4)](https://github.com/josephlewisnz "josephlewisnz (7 commits)")[![Liam-Bullock](https://avatars.githubusercontent.com/u/101078889?v=4)](https://github.com/Liam-Bullock "Liam-Bullock (1 commits)")[![brad-ps](https://avatars.githubusercontent.com/u/107819630?v=4)](https://github.com/brad-ps "brad-ps (1 commits)")[![thats4shaw](https://avatars.githubusercontent.com/u/855269?v=4)](https://github.com/thats4shaw "thats4shaw (1 commits)")

---

Tags

silverstripe

### Embed Badge

![Health badge](/badges/plasticstudio-iconfield/health.svg)

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

PHPackages © 2026

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