nthmedia/cp-site-icons

Display site icon when editing entries

3.0.2 2024-11-20 15:11 UTC

Requires

• php: ^8.0
• craftcms/cms: ^5.0.0

Requires (Dev)

• craftcms/ecs: dev-main
• craftcms/rector: dev-main
• phpstan/phpstan: ^1.6

MIT

• NTH media

• cms
• Craft
• craftcms
• craft-plugin
• cp site icons

README

Display site icon when editing entries, to be able to distinguish between different sites.

Requirements

This plugin requires Craft CMS 3 or 4

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

    cd /path/to/project
   

2. Then tell Composer to load the plugin:

    composer require nthmedia/cp-site-icons
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for CP Site Icons. Or enable it through the command line:

    ./craft plugin/install cp-site-icons
   

4. You can choose if you want the site handle or site language as key to distinguish your sites. This key is also the key of the icons array in the config:

5a. Create /config/cp-site-icons.php and add your configuration, for example:

<?php

return [
   'icons' => [
      'de' => '🇩🇪',
      'de-AT' => '🇦🇹',
      'en' => '🇬🇧',
      'es' => '🇪🇸',
      'fr' => '🇫🇷',
      'it' => '🇮🇹',
      'nl' => '🇳🇱',
      'nl-BE' => '🇧🇪',
   ],
];

5b. You can also use handles and/or custom CSS properties:

<?php

return [
   'icons' => [
      'siteA' => [
         'background' => 'url(/favicon/favicon-32x32.png)',
         'background-size' => 'cover',
         'content' =>  '""',
      ],
];

Credits

• Brought to you by NTH media
• Based on a code snippet of Dennis Frank, shared at DotAll 2021.