wp-cli/wp-cli-reference-command
2
0
Fork 0
mirror of https://ghproxy.net/https://github.com/mehrshaddarzi/wp-cli-reference-command.git synced 2025-10-04 04:54:49 +08:00
Code Issues Projects Packages Wiki Activity Actions
WordPress Code Reference Package for WP-CLI
22 commits 1 branch 4 tags 132 KiB
Find a file
Exact
Mehrshad Darzi 8ad5aae7be
Add PHP v8
2021-07-20 07:32:35 +04:30
src Check Writable Cache dir 2020-02-20 17:34:34 +03:30
tests minor improvement 2020-02-15 11:45:09 +03:30
.gitignore init commit 2019-04-25 19:13:09 +04:30
.travis.yml Improvement Code Format 2020-02-13 19:50:21 +03:30
command.php Check Writable Cache dir 2020-02-20 17:34:34 +03:30
composer.json Add PHP v8 2021-07-20 07:32:35 +04:30
LICENSE Create LICENSE 2020-02-13 20:09:35 +03:30
phpcs.xml Improvement Code Format 2020-02-13 19:50:21 +03:30
phpunit.xml Improvement Code Format 2020-02-13 19:50:21 +03:30
README.md Update README.md 2020-02-13 20:13:24 +03:30
screenshot-1.jpg Add ScreenShot 2019-04-25 21:01:44 +04:30
screenshot-2.jpg Add ScreenShot 2019-04-25 21:01:44 +04:30
wp-cli.yml fix namespace 2019-04-25 20:47:31 +04:30

README.md

WP-CLI Reference Command

Build Status Packagist Version GitHub

WordPress Code Reference in WP-CLI.

Quick links: Installation | Using | Contributing

Installation

You can install this package with:

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 <class|method|function|hook>

Search and show document

wp reference absint

result :

If your search results from more than one item. for example:

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:

wp reference --class=wp_user

wp reference --funcion=wp_insert_post

wp reference --method=get_row

wp reference --hook=admin_footer

Show in Web Browser

You can show WordPress code reference in Web browser after search with:

wp reference --browser

Cache system

By default, WP-CLI cached 1000 last searches for speed result. if you want to remove reference cache:

wp cli cache clear

If you want only remove reference cache:

wp reference --clear

Author

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 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 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.