hiwelo / raccoon-plugin Goto Github PK

With Raccoon, use a JSON or YAML file to manage WordPress theme features

License: GNU General Public License v3.0

PHP 100.00%

wordpress wordpress-plugin wordpress-configuration wordpress-admin wordpress-development yaml json

raccoon-plugin's Introduction

Raccoon WordPress plugin

Raccoon Plugin is a WordPress plugin which allows you to easily manage WordPress theme features with a JSON or YAML configuration file.

Summary

Dev requirements
Installation
After installation
Manifest JSON or YAML file
Documentation
Third-part features

Dev requirements

For its development, Raccoon Plugin requires:

PHP >= 5.6
Composer
WordPress >= 4.4

Installation

To install the Raccoon Plugin in your WordPress project, you can :

Clone the repository in your WordPress plugin directory : git clone https://github.com/hiwelo/raccoon-plugin.git
If your using Composer and an environment like Bedrock : composer require hiwelo/raccoon-plugin

If you want to install this plugin directly in your WordPress without Composer, I suggest you to install it in the Must-Use Plugins mu-plugins/ directory.

If you want to install this plugin with Composer, note that this package has a specific type (wordpress-muplugin) for a direct installation into the mu-plugins/ directory (like in Bedrock).

After installation

If the plugin is in the WordPress mu-plugins/ directory, you do not need to do something special to activate it. You just need to create a manifest.json file in your theme's root directory to use it.

If the plugin is in the WordPress plugins/ directory, do not forget to activate it in the WordPress admin panel and create the manifest.json file in your theme's root directory.

Manifest JSON or YAML file

Once you created the JSON or YAML file in your theme's root directory, you can use in this file all features described in this project's wiki.

Third-part features

Raccoon loves Bedrock

Bedrock is a WordPress boilerplate which create a better projet structure mainly with a new wp-content/ folder renamed app/. Bedrock use Composer and environments variables.

By example, Raccoon can use environments variables from Bedrocks to know the environment status (development, production, staging) and manage which debug informations has to be returned by the theme. If you don't use Bedrock, you can manually set environment status in the manifest.json file like this :

{
  "environment-status": "development"
}

raccoon-plugin's People

Contributors

Stargazers

Watchers

Forkers

lilobase stephanie-walter rudloff waffle-iron

raccoon-plugin's Issues

Adding post format (un)registration support

https://codex.wordpress.org/Post_Formats

Use YAML for config

Add a Jetpack setup function and Jetpack global support

Set up the WordPress core custom header feature with Raccoon

Post excerpt – Replace [...] by another string

Fatal error when deploying to production

I'm not sure if this is an issue with Raccoon itself, or my manifest file. But when I deploy a site with Raccoon (loaded as an mu-plugin) to production, WordPress crashes and PHP logs the following error:

PHP Fatal error: Uncaught Error: Cannot use object of type Hiwelo\Raccoon\Manifest as array in /srv/users/serverpilot/apps/phmass-org-prod/web/app/mu-plugins/raccoon-plugin/lib/Raccoon.php:156 Stack trace: #0 /srv/users/serverpilot/apps/phmass-org-prod/web/app/mu-plugins/raccoon-plugin/lib/Raccoon.php(72): Hiwelo\Raccoon\Raccoon->loadEnvironmentStatus() #1 /srv/users/serverpilot/apps/phmass-org-prod/web/app/mu-plugins/raccoon-plugin/raccoon.php(38): Hiwelo\Raccoon\Raccoon->__construct() #2 /srv/users/serverpilot/apps/phmass-org-prod/web/wp/wp-includes/plugin.php(524): Roots\Bedrock\Autoloader::Hiwelo\Raccoon{closure}('') #3 /srv/users/serverpilot/apps/phmass-org-prod/web/wp/wp-settings.php(395): do_action('after_setup_the...') #4 /srv/users/serverpilot/apps/phmass-org-prod/web/wp-config.php(9): require_once('/srv/users/serv...') #5 /srv/users/serverpilot/apps/phmass-org-prod/web/wp/wp-load.php(44): require_once('/srv/users/serv...') #6 /srv/users/serverpilot/apps/phmass-org-prod/web/wp/wp-blog-header.php(13): require_once('/ in /srv/users/serverpilot/apps/phmass-org-prod/web/app/mu-plugins/raccoon-plugin/lib/Raccoon.php on line 156

Theme namespace

Once the namespace is processed by the plugin, it would be better to declare a constant rather than a global variable.

Image size management

Add a feature in the manifest to declare new image size format generated by WordPress.

https://developer.wordpress.org/reference/functions/add_image_size/

SVG upload doesn't work even if asked in the manifest

raccoon.yml project file:

theme-features:
  svg-upload: true

WordPress message after uploading a SVG in the media library:

Sorry, this file type is not permitted for security reasons.

Permettre de limiter l'extrait d'un contenu

Mettre en place au sein du manifeste un moyen de limiter la taille en mot de l'excerpt WordPress.

Post status name don't appear on post list page

Custom Post Types – add link in Menu admin panel screen

Create a way to trigger flush_rewrite_rules() with a URL like ?flush_rewrite_rules

Post-thumbnails non fonctionel

La fonctionnalité "post-thumbnails": true définie dans "theme-support" ne semble pas fonctionnelle.

Custom image size are not activated in the source code

Registration of new images size exists in the source code but it's not called by the plugin.

Including CSS & JavaScript via Raccoon

Declare JS & CSS files to include in the manifest
https://developer.wordpress.org/themes/basics/including-css-javascript/

Taxonomy registration

Would it be possible to add this as a module? I see in the post type specification that you can attach existing taxonomies to a post type, but creating the taxonomy still needs to be done via standard WP functions. It would be great to have all of the taxonomy/post type stuff in the same place.

/* Enable SVG upload */
add_filter('upload_mimes', function ($mimes) {
    $mimes['svg'] = 'image/svg+xml';
    return $mimes;
});