readme.txt
=== Site Icon Extended ===
Plugin Name: Site Icon Extended
Plugin URI: https://wordpress.org/plugins/site-icon-extended/
Author: Felix Arntz
Author URI: https://leaves-and-love.net
Contributors: flixos90
Donate link: https://leaves-and-love.net/wordpress-plugins/
Requires at least: 4.3
Tested up to: 4.5.3
Stable tag: 0.2.6
Version: 0.2.6
License: GNU General Public License v3
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Tags: site-icon, icon, favicon, browser, compatibility, browserconfig, ico, apple-touch-icon, pinned-tab-icon
This plugin enhances the WordPress Site Icon feature by adding more icon formats for improved cross-browser compatibility.
== Description ==
The WordPress Site Icon feature added with version 4.3 introduces a standardized way to add a site icon (also referred to as just "icon" or "favicon") to your site - awesome! No more bloated plugins necessary to have this feature, no more custom code required.
Why this plugin then? -, you might ask. While WordPress does a pretty decent job in terms of cross-browser compatibility of the icon, it still has some room to improve if you are interested in supporting all kinds of different devices. *Site Icon Extended* is a lightweight plugin to address just that, built upon the native Site Icon feature of WordPress.
= Features =
* adds more icon sizes for the default icon and Apple Touch Icon to better support different resolutions
* generates an `.ico` file to use for the general shortcut icon
* generates a `browserconfig.xml` file to support Windows 8.1
* allows upload and color specification of an SVG image to use as Pinned Tab Icon for Safari
* adds a Customizer field to specify an icon background color used by some Windows devices
**Note:** This plugin requires PHP 5.3.0 at least.
== Installation ==
1. Upload the entire `site-icon-extended` folder to the `/wp-content/plugins/` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress.
3. Open the Customizer to specify a Site Icon.
== Frequently Asked Questions ==
= Some of the different sizes are not generated correctly. Why is that? =
If you see that the `link` and `meta` tags in the head of your site do not output the file that corresponds to the size specified in the tag, you might have specified the Site Icon before activating the *Site Icon Extended* plugin. In this case, simply remove the Site Icon and then add it back again.
= Why can't I access the generated XML file? =
To access the generated XML (and to allow the browser to access it), some rewrite rules are necessary. If you are not able to access the file, it's probably because your rewrite rules have not been flushed correctly. Please navigate to the *Settings > Permalinks* page in the WordPress admin and just hit *Save* without changing anything to flush the rewrite rules.
= The plugin allows users to upload SVG images. How can I disable that? =
The ability to upload SVG images is required to use the Pinned Tab Icon for Safari. If you don't care about that feature or you simply want to disallow SVG uploads, you can define a constant with the name `WPSIE_PREVENT_SVG_UPLOAD` and set it to `true`.
= Where should I submit my support request? =
I preferably take support requests as [issues on Github](https://github.com/felixarntz/site-icon-extended/issues), so I would appreciate if you created an issue for your request there. However, if you don't have an account there and do not want to sign up, you can of course use the [wordpress.org support forums](https://wordpress.org/support/plugin/site-icon-extended) as well.
= How can I contribute to the plugin? =
If you're a developer and you have some ideas to improve the plugin or to solve a bug, feel free to raise an issue or submit a pull request in the [Github repository for the plugin](https://github.com/felixarntz/site-icon-extended).
You can also contribute to the plugin by translating it. Simply visit [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/site-icon-extended) to get started.
== Screenshots ==
1. The generated meta tags
2. The browserconfig.xml file
3. The new Site Icon background field in the Customizer
== Changelog ==
= 0.2.6 =
* Tweaked: updated plugin initialization library
= 0.2.5 =
* Tweaked: plugin now uses wordpress.org language packs
* Tweaked: updated plugin initialization library
= 0.2.4 =
* Enhanced: plugin can now easily be used as a must-use plugin
= 0.2.3 =
* Fixed: removed .gitignore from svn repo
= 0.2.2 =
* Fixed: on PHP 5.2 the plugin now terminates appropriately
= 0.2.1 =
* Fixed: critical error that could happen when using a composer-managed WordPress setup
= 0.2.0 =
* Added: a Pinned Tab Icon (also called mask icon) for Safari can now be uploaded
* Tweaked: changed textdomain to `site-icon-extended` for translate.wordpress.org
= 0.1.0 =
* Initial release
== Credits ==
Some of the code related to integrate the `browserconfig.xml` file was heavily inspired by the *Yoast SEO* plugin which uses a similar technique to handle its sitemap files.
= Third-Party Libraries =
The plugin uses the [PHP_ICO](https://github.com/chrisbliss18/php-ico) class to generate the `.ico` file.