https://github.com/mehrshaddarzi/wp-cli-trait-command
WP-CLI Trait Package Command
https://github.com/mehrshaddarzi/wp-cli-trait-command
wordpress-plugin wp-cli wp-cli-command wp-cli-package
Last synced: 16 days ago
JSON representation
WP-CLI Trait Package Command
- Host: GitHub
- URL: https://github.com/mehrshaddarzi/wp-cli-trait-command
- Owner: mehrshaddarzi
- License: mit
- Created: 2021-10-02T05:12:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T14:06:35.000Z (almost 3 years ago)
- Last Synced: 2023-07-15T10:47:04.885Z (over 2 years ago)
- Topics: wordpress-plugin, wp-cli, wp-cli-command, wp-cli-package
- Language: PHP
- Homepage:
- Size: 85.9 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WP-CLI Trait Package Command
Generate plugin or php model files e.g. post-type or taxonomy for [WP-Trait](https://github.com/mehrshaddarzi/wp-trait) Package in Develop WordPress Plugin.
## Installation
You can install this package with:
```console
wp package install mehrshaddarzi/wp-cli-trait-command
```
> Installing this package requires WP-CLI v2 or greater. Update to the latest stable release with `wp cli update`.
## Structure
```
NAME
wp trait
DESCRIPTION
WP-CLI Trait Package Command.
SYNOPSIS
wp trait
SUBCOMMANDS
add Add Custom Package.
make Generate Model Files.
remove Remove Custom Package.
start Generates starter code for a plugin
```
### Generate Plugin
Use This Command:
```console
wp trait start
```
And fill Your Plugin information e.g. slug and namespace:
```
1/12 [--slug=]: wp-plugin
2/12 [--namespace=]: WP_Plugin
3/12 [--plugin_name=]: plugin-name
4/12 [--plugin_description=]: your plugin description
5/12 [--plugin_author=]: Mehrshad Darzi
6/12 [--plugin_author_uri=]: https://profiles.wordpress.org/mehrshaddarzi/
7/12 [--plugin_uri=]: https://github.com/mehrshaddarzi/wp-trait
8/12 [--skip-tests] (Y/n): n
9/12 [--ci=]: travis
10/12 [--activate] (Y/n): y
11/12 [--activate-network] (Y/n): n
12/12 [--force] (Y/n): y
```
### Make PHP Model
Create php model:
```console
wp trait make model
```
> Notice: To execute the command to create a model or post-type, you must change the directory of your terminal address from the WordPress root to the plugin folder. for example first run `cd wp-content/plugins/my-plugin` command and then run `wp trait make`
#### Create Model With Class Name:
```console
wp trait make model Option
```
#### Create Model With Nested Namespace:
```console
wp trait make model User/Register
```
#### Create Model With Custom global Variable in Plugin:
```console
wp trait make model User/Signup --var=register
```
### Make WordPress Post Type
Make a new post-type in WordPress:
```console
wp trait make post-type
```
#### Create A new Post Type With `City` slug:
```console
wp trait make post-type City
```
After created You can change `register_post_type` argument in main plugin files.
#### Create a new Post Type With Nested NameSpace:
```console
wp trait make post-type Post/Orders order
```
### Make WordPress Taxonomy
Make a new taxonomy in WordPress:
```console
wp trait make taxonomy
```
#### Create A new Taxonomy With `Country` slug:
```console
wp trait make taxonomy Country
```
After create You can change register_taxonomy argument in main plugin files.
#### Create a new Taxonomy With Nested NameSpace and Custom name:
```console
wp trait make taxonomy Media/Category media_cat Category
```
### Add or Remove Package
```console
wp trait add
```
```console
wp trait remove
```
#### List Of Trait Package
| package | description |
|------------|---------------------------------------------------------------------------|
| ide-helper | Create WP-Trait method helper for developer in IDE software e.g. PHPStorm |
| cmb2 | Add [CMB2](https://github.com/CMB2/CMB2) Framework to your plugin |
## Author
- [Mehrshad Darzi](https://www.linkedin.com/in/mehrshaddarzi/) | PHP Full Stack and WordPress Expert
## Contributing
We appreciate you taking the initiative to contribute to this project.
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
### Reporting a bug
Think you’ve found a bug? We’d love for you to help us get it fixed.
Before you create a new issue, you should [search existing issues](https://github.com/mehrshaddarzi/wp-cli-trait-command/issues) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
### Creating a pull request
Want to contribute a new feature? Please first [open a new issue](https://github.com/mehrshaddarzi/wp-cli-trait-command/issues/new) to discuss whether the feature is a good fit for the project.
Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
1. Create a feature branch for each contribution.
2. Submit your pull request early for feedback.
3. Follow [PSR-2 Coding Standards](http://www.php-fig.org/psr/psr-2/).