Mudrava Icon Field for ACF with Lucide
| 开发者 | mudrava |
|---|---|
| 更新时间 | 2026年9月1日 19:25 |
| PHP版本: | 7.4 及以上 |
| WordPress版本: | 7.1 |
| 版权: | GPL-2.0-or-later |
| 版权网址: | 版权信息 |
详情介绍:
- Visual Icon Picker - Browse and select from 1,791 Lucide icons and 3,457 brand logos
- Brand Icons - Brand logos use Simple Icons values such as
simple:facebook - Custom Icon Library - Upload your own SVG icons under Settings, sanitized on upload and addressable as
custom:<name> - Shortcode & Helper -
[lucide_icon]shortcode plusmudrava_get_lucide_icon()helper for templates - Smart Search - Filter icons by name or tags instantly
- Performant - Lazy icon catalog over a local REST endpoint, byte-offset sprite lookups, inline frontend SVG output, paginated grid (100 icons per page)
- Native ACF Look - Seamlessly integrates with ACF's design language
- Responsive - Works on all screen sizes
- Accessible - Keyboard navigation support
- Flexible Output - Return icon value or full SVG markup
- No External Requests - All icon data is stored locally
- Go to Custom Fields > Add New
- Add a new field and select Lucide Icon as the field type
- Configure the field settings (default value, return format, etc.)
- Save your field group
<?php $icon_name = get_field('your_field_name'); echo esc_html($icon_name); // Returns: 'rocket' ?>
Get SVG Markup (with return_format = 'svg'):
<?php $icon_svg = get_field('your_field_name'); echo $icon_svg; // Returns: <svg>...</svg> ?>
Using the Helper Function:
`<?php
// Basic usage
echo mudrava_get_lucide_icon('rocket');
// With custom attributes
echo mudrava_get_lucide_icon('rocket', [
'class' => 'my-custom-class',
'width' => 32,
'height' => 32,
'stroke' => '#ff0000',
'title' => 'Launch', // accessible title
'mode' => 'sprite', // 'inline' (default) or 'sprite'
]);
?>`
Shortcode
[lucide_icon name="rocket" size="32" title="Launch"]
Custom icons uploaded under Settings → Custom Icons are addressed as custom:<name>,
for example [lucide_icon name="custom:my-logo" title="My Logo"] or
mudrava_get_lucide_icon( 'custom:my-logo' ).
About Custom SVG Icons
Site owners can upload plain SVG icons under Settings → Custom Icons.
Uploads are parsed with DOMDocument (no network access) and reduced to the
same element and attribute allowlist as the bundled sets via wp_kses(), so
scripts, styles, embedded images and unsupported elements never reach storage.
Custom icons are stored as standalone files in the uploads directory, appear
in the picker search, and render with their own colors instead of a forced
currentColor tint.
About Lucide Icons
Lucide is a modern, open-source icon library with 1,700+ carefully crafted icons. The bundled Lucide assets are from lucide-static 1.38.0 and are licensed under ISC.
About Brand Icons
Brand logos are bundled separately from Simple Icons 16.29.0 and are saved with the simple: prefix, for example simple:facebook.
Simple Icons is distributed under CC0-1.0, but individual brand logos and trademarks may still be governed by each brand owner's guidelines and permissions. Check the relevant brand guidelines before using a logo in production. Source and guideline URLs from Simple Icons are bundled in data/brand-icons-meta.json.
安装:
- WordPress 6.0 or higher
- PHP 7.4 or higher
- Advanced Custom Fields (ACF) 6.0 or higher (required)
- Install and activate ACF (if not already installed)
- Upload the
mudrava-acf-lucide-fieldfolder to/wp-content/plugins/ - Activate the plugin through the 'Plugins' menu in WordPress
- The new "Lucide Icon" field type will appear in ACF field type selection
- Go to Plugins > Add New > Upload Plugin
- Upload the plugin zip file
- Click Install Now and then Activate
常见问题:
Do I need ACF Pro for this plugin to work?
No. The field type works with Advanced Custom Fields 6.0 or higher. It also works inside ACF Pro field groups such as Repeaters and Flexible Content.
Will the plugin work if I deactivate ACF?
No, the plugin will show an admin notice and the field type will not be available. You must keep ACF active.
Does this plugin make external requests?
No. All icon data is stored locally in the plugin files. No external API calls or CDN requests are made.
Where are the icons stored?
Lucide SVG data is bundled in assets/sprite.svg. Brand logo SVG data is bundled in assets/brand-sprite.svg. Search metadata is built into data/icons.json, data/brand-icons.json, data/lucide-tags.php, data/simple-tags.php and byte-offset lookups in data/lucide-index.php and data/simple-index.php. The admin picker loads the catalog lazily through a local REST endpoint (wp-json/mudrava-lucide/v1/icons, logged in by default). Everything runs locally on your server.
Why did social or brand icons disappear after updating Lucide assets?
Lucide v1 removed most brand icons from the current packages. Version 1.1.0 updates Lucide to lucide-static 1.14.0 and adds a separate Simple Icons brand bundle, which is the recommended direction for brand logos. New brand values are saved as simple:<slug>, and legacy unprefixed social values such as facebook, instagram, twitter, or youtube are resolved against Simple Icons when they no longer exist in Lucide.
What happens if an icon name was removed in a library update?
Saved values are never rewritten. Icons removed in lucide-static 1.38.0 (angry, annoyed, frown, history, laugh, meh, podcast, smile, smile-plus) are mapped to canonical replacements in data/compat-aliases.json, for example smile renders as face-slightly-smiling. Unknown values that have no alias keep saving and surface as a dismissible admin notice; set the field setting "Unknown Icon Values" to "error" to make validation strict instead.
Can I use this with ACF Repeater or Flexible Content fields?
Yes, the Lucide Icon field works perfectly within Repeater fields, Flexible Content fields, and any other ACF field groups.
What format does the field return?
You can configure the return format in the field settings:
- Icon Name - Returns the icon value as a string (e.g., "rocket" or "simple:facebook")
- SVG Markup - Returns the complete SVG HTML code
How do I customize the icon appearance?
Use the mudrava_get_lucide_icon() helper function with custom attributes for width, height, stroke color, fill color, and CSS classes.
Is the plugin translation-ready?
Yes, the plugin is fully translation-ready with text domain mudrava-acf-lucide-field. Translation files should be placed in the /languages/ directory.
更新日志:
- Update bundled assets to
lucide-static1.38.0 andsimple-icons16.29.0. - Replace the 600 KB admin payload with a lazy REST icon catalog.
- Replace regex sprite extraction with byte-offset index lookups (no full-file scans per render).
- Render icons as inline SVG by default and support a
spritemode with a footer sprite sheet. - Add a compatibility alias layer (
data/compat-aliases.json) for icon names removed upstream; saved values are never rewritten. - Unknown icon values no longer block saving by default; they show a dismissible admin notice. A per-field "Unknown Icon Values" setting (
warn/error) controls strict mode. - Harden SVG handling with a build-time allowlist (
data/allowed-svg.json) and runtimewp_ksessanitization. - Add a custom SVG icon library: upload icons under Settings, sanitized against the same allowlist and stored as standalone files; addressable as
custom:<name>in the field, picker, shortcode and helper. - Add the
[lucide_icon]shortcode withmudrava_lucide_icon_svg_argsandmudrava_lucide_icon_svgfilters. - Bundle minified sprite assets and add scripted asset pipeline checks.
- Add PHPUnit unit tests and PHPCS/ESLint configs.
- Update bundled Lucide assets to
lucide-static1.14.0. - Add a separate Simple Icons 16.18.0 brand icon bundle with 3,400+ brand logos.
- Save new brand icon selections as
simple:<slug>. - Resolve legacy unprefixed social icon values against Simple Icons when Lucide no longer contains them.
- Add third-party notices and brand-logo usage guidance.
- Render frontend helper output as inline SVG instead of external sprite references.
- Avoid stale transient icon lists after sprite updates.
- Improve keyboard focus and dropdown stacking in ACF Repeater/Flexible Content contexts.
- Validate saved icon names against the bundled local sprite.
- Clarify ACF 6.0+ requirement and Lucide v1 brand icon behavior.
- Initial release
- Visual icon picker with 1,500+ Lucide icons
- Real-time search and filter functionality
- Icon name or SVG return format options
- Helper function for template use
- Allow null option for optional icon selection
- Default value configuration
- Custom placeholder text setting
- Keyboard navigation support
- RTL language support
- Responsive grid layout
- Native ACF styling integration
- Local sprite file (no external requests)
- Bundled icon metadata for instant search
- Full compatibility with ACF Repeater and Flexible Content fields