README

WP Starter Theme is a modern WordPress theme designed to provide a solid foundation for building custom themes. It leverages modern PHP practices and integrates seamlessly with the WordPress ecosystem.

Requirements

WordPress 6.0 or later.
PHP 8.0 or higher.
Roots Acorn 4.3 or higher.

Installation

To install CI WP Starter Theme in your WordPress project using Roots Acorn, follow these steps:

Ensure you have Composer installed and initialized in your WordPress project. If you're using Bedrock, Composer is already set up.
Add the CI WP Starter Theme package to your project by running the following command in your terminal from your theme directory:

composer require concept-image/wp-starter-theme

Publishing Assets

After installing the theme, you need to discover and publish the theme's assets using Acorn. Run the following command:

wp acorn vendor:publish --tag="wp-starter-theme"

This command will publish the necessary assets to your theme's public directory.

Views, Styles, and Scripts

Views

The theme's view files are located in the resources/views directory. These files are responsible for rendering the HTML structure of your theme. You can customize these views to match your design requirements.

Styles

The theme's styles are located in the resources/styles directory. This directory contains all the CSS and SCSS files used to style your theme. You can add or modify these files to customize the appearance of your theme.

Scripts

The theme's scripts are located in the resources/scripts directory. This directory contains all the JavaScript files used to add interactivity to your theme. You can add or modify these files to enhance the functionality of your theme.

Vite

Install NPM depencies in the theme directory with the command:

npm install

Usage

Development:

To start the development server, run:

npm run dev

This will start the Vite development server on the specified port (default is 5173).

Build:

To build the project for production, run:

npm run build

Hooks and Functions

The theme registers various hooks and functions through the provider located in the app/Providers/CiWpStarterThemeServiceProvider.php file. This provider is responsible for:

Registering theme support: Adds support for various WordPress features such as post thumbnails, custom logos, and more. Registering custom hooks: Adds custom hooks that can be used throughout the theme to extend functionality. Registering custom functions: Adds custom functions that can be used in your theme's templates and other files. You can customize the hooks and functions by modifying the CiWpStarterThemeServiceProvider.php file according to your needs.

Changelog

Please refer to CHANGELOG for more information.

Contributing

Please refer to CONTRIBUTING for more information.

License

Please refer to LICENSE for more information.

concept-image / wp-starter-theme

Maintainers

Details