/bs-theme

A basic starter theme for WordPress and ClassicPress.

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

BS Theme

A basic starter theme for WordPress and ClassicPress.

PHP tested on version 7.4.8 WordPress tested on version 5.7.2 ClassicPress tested on version 1.2.0 SASS Ready Gutenberg Ready ACF Pro Ready No PHP Composer Never AMP

See BS Plugin for a basic WordPress/ClassicPress starter plugin.

BS Theme Screenshot

Requirements

  • This theme was written in a WordPress 5.0+ environment with no concern for backwards compatibility. However, it is currently tested with no issues in ClassicPress 1.2.0.
  • This theme was written on a local server running PHP 7.4
  • The short array syntax ( [] rather than array() ) requires PHP 5.4+
  • Class files are namespaced and the methods of which must be called accordingly in template parts.

Build Details & Extras

  • Header, navigation, and footer loaded via hook so that they may be unhooked.
  • Widget to toggle light and dark themes.
  • Sample theme options page ready to begin developing.
  • Theme info page as an example for getting theme data.
  • Bundle & load plugins by adding to the includes/vendor directory and extend the Plugin class.
  • Fully SASS (SCSS) ready with modules and partials directories.
  • Right-to-left (RTL) stylesheets are provided, and existing left-right styles are reversed.

Advanced Custom Fields

The theme is ready to bundle a copy of Advanced Custom Fields basic or Pro. Simply add the contents of the plugin folder to the includes/vendor/acf directory and Advanced Custom Fields is automatically loaded, if the plugin is not active via the plugins interface.

If the includes/vendor/acf directory is not used as the root directory of the plugin then change the directory name, and core filename in the ACF class file properties:
@see includes/classes/vendor/class-acf.php.

  • There is a before_html hook before the opening <html> tag for ACF frontend forms.
  • Template files look for content template-parts files ending with -acf.
  • An ACF JSON directory is ready to use, filters added in the ACF class.

Renaming, Rebranding, and Defaults

Following is a list of strings to find and replace in all theme files.

  1. Plugin name
    Find BS_Theme and replace with your theme name, include underscores between words. This will change the namespace and the package name in file headers.

  2. Text domain
    Find bs-theme and replace with the text domain of your theme.

  3. Theme prefix Find bst and replace with the unique, lowercase theme prefix. This prefix is used for applied filters, stylesheet IDs, and admin page URIs, so the prefix may be followed by an underscore or a dash. Search for bst_ and bst- to find the difference.

  4. Constant prefix
    Find BST and replace with the uppercase prefix of your theme.

  5. Header image
    Find the default header image file, default-header.jpg, in the assets/images/ directory and replace with your default image.

  6. Activation and deactivation
    Check the activation and deactivation classes, includes/class-activate and includes/class-deactivate, for sample methods. Remove or modify the samples as needed.

  7. README file
    Whether or not your theme will be kept in a version control repository, edit the content of the README file in the theme's root directory or delete it if it is not necessary.