Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mehrshaddarzi/wp-cli-reference-command
WordPress Code Reference Package for WP-CLI
https://github.com/mehrshaddarzi/wp-cli-reference-command
wordpress wordpress-code-reference wordpress-codex wordpress-development wp-cli wp-cli-command wp-cli-package
Last synced: 29 days ago
JSON representation
WordPress Code Reference Package for WP-CLI
- Host: GitHub
- URL: https://github.com/mehrshaddarzi/wp-cli-reference-command
- Owner: mehrshaddarzi
- License: mit
- Created: 2019-04-25T13:35:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T03:02:35.000Z (over 3 years ago)
- Last Synced: 2024-09-27T14:42:32.183Z (about 1 month ago)
- Topics: wordpress, wordpress-code-reference, wordpress-codex, wordpress-development, wp-cli, wp-cli-command, wp-cli-package
- Language: PHP
- Homepage:
- Size: 99.6 KB
- Stars: 12
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WP-CLI Reference Command
[](https://travis-ci.com/mehrshaddarzi/wp-cli-reference-command)  
WordPress Code Reference in WP-CLI.
Quick links: [Installation](#installation) | [Using](#using) | [Contributing](#contributing)
## Installation
You can install this package with:
```console
wp package install mehrshaddarzi/wp-cli-reference-command
```
Installing this package requires WP-CLI v2 or greater. Update to the latest stable release with `wp cli update`.
## Using
```
NAME
wp reference
DESCRIPTION
WordPress Code Reference.
SYNOPSIS
wp reference
```
### Search and show document
```console
wp reference absint
```
result :
If your search results from more than one item.
for example:
````console
wp reference wp_insert_post
````
You will see a list to choose from.
### Custom Search
By default WP_CLI reference package search between all WordPress class and functions.
If you want the custom search:
```console
wp reference --class=wp_user
```
```console
wp reference --funcion=wp_insert_post
```
```console
wp reference --method=get_row
```
```console
wp reference --hook=admin_footer
```
### Show in Web Browser
You can show WordPress code reference in Web browser after search with:
```console
wp reference --browser
```
### Cache system
By default, WP-CLI cached `1000` last searches for speed result. if you want to remove reference cache:
```console
wp cli cache clear
```
If you want only remove reference cache:
```console
wp reference --clear
```
## 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-reference-command/issues?q=label%3Abug%20) 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-reference-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/).