kingkool68 / wordpress-rh-starter-theme

My preferred WordPress starter theme

Russell Heimlich's Starter WordPress Theme

Getting Started

Install Composer dependencies for PHPCS and code linting: composer install

Install node dependencies like Gulp: npm install

Start Gulp wich will watch for changes and recompile Sass and JavaScript: npm run start

Templating

Rendering markup is handled by passing data to Twig templates via Sprig. WordPress escaping functions are available as Twig filters.

CSS

Sass files get compiled to rh.min.css which is heavily optimized for performant delivery. See the class-rh-scripts-and-styles.php file for helper methods.

JavaScript

JavaScript files wil lbe uglified and minified in the /wp-content/themes/rh/assets/js/ directory. Scripts must end with the extension .src.js in order for them to be compiled. Scripts without the .src.js suffix will be deleted by the Gulp watch process when they are recompiled. When in production you should call the uglified and minified version. See the class-rh-scripts-and-styles.php file for helper methods.

Styleguide

This theme comes with a styleguide built in to the theme. Visit /styleguide/ to access the files in the /styleguide/ directory of the theme. /styleguide/colors/ corresponds to the /styleguide/colors.php in the theme. Be sure to add any components or modules to the styleguide to make quality control easier.

wordpress-rh-starter-theme's Issues

Add some of these WordPress functions to `class-rh-security.php`

See https://smitka.me/2024/04/05/13-extra-things-we-do-for-better-wordpress-security/

Fix ACF select2 Fields from Escaping SVG Markup

Yuck! This isn't usable!

Add Logic for Dynamic Image Resizing

• Should limit creating different image sizes on upload. Only want to keep the original size and resize other needed sizes on demand.
• If resizing query strings are present redirect request to Photon URL. See https://developer.wordpress.com/docs/site-accelerator/site-accelerator-api/

Resources

• My Photon plugin by Alley Interactive
• Photon Dockerfile
• Photon source code
• Disable Generate Thumbnails plugin
• .htaccess Testing Tool]
• Tachyon Plugin which handles appending size query args to image URLs
• We need to remove image sizes to prevent intermediate sizes from being generated and then we need to reconstruct attachment meta data and add sizes back in so we can pick different sizes within the editor. See https://github.com/Automattic/vip-go-mu-plugins/blob/8de9938b4ba83980f1751a86a872c119fa09160d/files/class-image-sizes.php#L44C2-L100
• Maybe instead of filtering on wp_update_attachment_metadata we filter on the wp_get_attachment_metadata