https://github.com/kermage/themeplate

A toolkit to handle everything related in developing a full-featured WordPress site
https://github.com/kermage/themeplate

toolkit wordpress wordpress-plugin

Last synced: 2 months ago
JSON representation

A toolkit to handle everything related in developing a full-featured WordPress site

• Host: GitHub
• URL: https://github.com/kermage/themeplate
• Owner: kermage
• License: gpl-3.0
• Created: 2017-01-22T05:06:16.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T12:10:10.000Z (11 months ago)
• Last Synced: 2024-04-05T12:44:48.298Z (10 months ago)
• Topics: toolkit, wordpress, wordpress-plugin
• Language: PHP
• Homepage:
• Size: 1000 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ThemePlate -- ![Scrutinizer Build Status](https://scrutinizer-ci.com/g/kermage/ThemePlate/badges/build.png) ![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/kermage/ThemePlate/badges/quality-score.png)

> *"A toolkit to handle everything related in developing a full-featured WordPress site"*

- Add meta boxes to posts, terms, users, and menu items

- Register custom post types and custom taxonomies

- Create options pages and add custom admin columns

- Frontend markup cleaner with a clean navwalker

## Features

- Fully compatible with the new block editor: Gutenberg

- Work similarly to native WordPress function/methods

- Look seamlessly beautiful to WordPress pages/panels

- Easy, simple, and straightforward as much as possible

## Getting Started

#### 1. Install the toolkit

- As a theme required plugin: Refer [here](http://tgmpluginactivation.com/installation/)

- As a must-use plugin: Refer [here](https://wordpress.org/support/article/must-use-plugins/)

#### 2. Add to theme's `functions.php` or plugin's `main php file`

```php

if ( class_exists( 'ThemePlate' ) ) :

	ThemePlate( array(

		'title' => 'Project Name',

		'key'   => 'project_prefix'

	) );

	require_once 'post-types.php';

	require_once 'settings.php';

	require_once 'meta-boxes.php';

endif;

```

- Initialize with an array consisting of a ***title*** and a ***key*** to be used as:

	- page and menu title in the pre-created options page

	- prefix to the registered option names and in every meta key

- Require files containing the definition of ***`ThemePlate-d`*** items

#### 3. Define items to be *`ThemePlate-d`*

- `ThemePlate()->post_type( $args );`

- `ThemePlate()->taxonomy( $args );`

- `ThemePlate()->settings( $args );`

- `ThemePlate()->post_meta( $args );`

- `ThemePlate()->term_meta( $args );`

- `ThemePlate()->user_meta( $args );`

- `ThemePlate()->menu_meta( $args );`

- `ThemePlate()->page( $args );`

- `ThemePlate()->column( $args );`

#### See the [Wiki](https://github.com/kermage/ThemePlate/wiki) section

---

### Yeoman Generator

Check [generator-themeplate](https://www.npmjs.com/package/generator-themeplate) to kickstart a **ThemePlate** powered WP site.