Modern Climate WordPress Starter Plugin

Starter WordPress plugin. Features SCSS compiler, TS/JS linting and minifying, and class-based php.

Requires a minimum of WordPress 6.0, PHP 8.0, and Composer 2

MC Starter Plugin is built with Composer and Vite usage in mind and is the recommended way to use this plugin.

What tools do I need to use the plugin?

1. Node.js
2. NVM
3. Yarn
4. Composer
5. PHP

Instructions

1. $ nvm i : Installs and switches to necessary node defined in .nvmrc
2. $ yarn install : Install yarn packages (postinstall will run composer install and vite build)

Vite Commands

All minified assets are created to the /build/ directory of the theme.

$ yarn run build : Builds assets folder, then compiles minified assets

$ yarn run watch : Watches assets folder for changes, then compiles minified assets

Composer notes

If you decide to update the psr-4 namespace prefix, you can use dump-autoload to do that without having to go through an install or update.

composer dump-autoload

Resources

1. PSR-4 Autoloader
2. PSR-2 PHP Coding Style Guide
3. Vite
4. TypeScript
5. Prettier
6. Sass 7-1 Pattern
7. Sass Lint

ACF Documentation

• Wordplate Extended ACF is included as the means to build fields, field groups, reusable fields
• Custom ACF Utility Functions are included in the theme to retrieve ACF data in a more effecient way: (https://github.com/ModernClimate/mc-wp-starter-theme/blob/master/doc/acf/README.md)

Extensions

Check out the Code Snippets Repo for additional functionality.

Documentation

• ACF Utility Functions
• ACF Field Registration
• Setting up autoformat on save in your code editor

Copyright and License

The following resources are included or used in part within the theme package.

• Underscores by Automattic, Inc. - Licensed under the GPL, version 2 or later.

All other resources and theme elements are licensed under the GNU GPL, version 2 or later.