{"id":14955184,"url":"https://github.com/mehrshaddarzi/wp-cli-reference-command","last_synced_at":"2025-10-24T07:30:55.906Z","repository":{"id":62526806,"uuid":"183441264","full_name":"mehrshaddarzi/wp-cli-reference-command","owner":"mehrshaddarzi","description":"WordPress Code Reference Package for WP-CLI","archived":false,"fork":false,"pushed_at":"2021-07-20T03:02:35.000Z","size":102,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-29T08:34:41.560Z","etag":null,"topics":["wordpress","wordpress-code-reference","wordpress-codex","wordpress-development","wp-cli","wp-cli-command","wp-cli-package"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mehrshaddarzi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-25T13:35:18.000Z","updated_at":"2024-04-16T14:50:56.000Z","dependencies_parsed_at":"2022-11-02T14:30:44.713Z","dependency_job_id":null,"html_url":"https://github.com/mehrshaddarzi/wp-cli-reference-command","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehrshaddarzi%2Fwp-cli-reference-command","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehrshaddarzi%2Fwp-cli-reference-command/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehrshaddarzi%2Fwp-cli-reference-command/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehrshaddarzi%2Fwp-cli-reference-command/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mehrshaddarzi","download_url":"https://codeload.github.com/mehrshaddarzi/wp-cli-reference-command/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237932070,"owners_count":19389560,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wordpress","wordpress-code-reference","wordpress-codex","wordpress-development","wp-cli","wp-cli-command","wp-cli-package"],"created_at":"2024-09-24T13:10:37.653Z","updated_at":"2025-10-24T07:30:55.492Z","avatar_url":"https://github.com/mehrshaddarzi.png","language":"PHP","readme":"# WP-CLI Reference Command\n\n[![Build Status](https://travis-ci.com/mehrshaddarzi/wp-cli-reference-command.svg?branch=master)](https://travis-ci.com/mehrshaddarzi/wp-cli-reference-command) ![Packagist Version](https://img.shields.io/packagist/v/mehrshaddarzi/wp-cli-reference-command) ![GitHub](https://img.shields.io/github/license/mehrshaddarzi/wp-cli-reference-command)\n\nWordPress Code Reference in WP-CLI.\n\nQuick links: [Installation](#installation) | [Using](#using) | [Contributing](#contributing)\n\n## Installation\n\nYou can install this package with:\n\n```console\nwp package install mehrshaddarzi/wp-cli-reference-command\n```\n\nInstalling this package requires WP-CLI v2 or greater. Update to the latest stable release with `wp cli update`.\n\n## Using\n\n```\nNAME\n\n  wp reference\n\nDESCRIPTION\n\n  WordPress Code Reference.\n\nSYNOPSIS\n\n  wp reference \u003cclass|method|function|hook\u003e\n\n```\n\n### Search and show document\n\n```console\nwp reference absint\n```\nresult :\n\n![](https://raw.githubusercontent.com/mehrshaddarzi/wp-cli-reference-command/master/screenshot-1.jpg)\n\n\nIf your search results from more than one item.\nfor example:\n\n````console\nwp reference wp_insert_post\n````\n\nYou will see a list to choose from.\n\n![](https://raw.githubusercontent.com/mehrshaddarzi/wp-cli-reference-command/master/screenshot-2.jpg)\n\n### Custom Search\n\nBy default WP_CLI reference package search between all WordPress class and functions.\n\nIf you want the custom search:\n\n```console\nwp reference --class=wp_user\n```\n\n```console\nwp reference --funcion=wp_insert_post\n```\n\n```console\nwp reference --method=get_row\n```\n\n```console\nwp reference --hook=admin_footer\n```\n\n\n### Show in Web Browser\n\nYou can show WordPress code reference in Web browser after search with:\n\n```console\nwp reference --browser\n```\n\n### Cache system\n\nBy default, WP-CLI cached `1000` last searches for speed result. if you want to remove reference cache:\n\n```console\nwp cli cache clear\n```\n\nIf you want only remove reference cache:\n\n```console\nwp reference --clear\n```\n\n## Author\n\n- [Mehrshad Darzi](https://www.linkedin.com/in/mehrshaddarzi/) | PHP Full Stack and WordPress Expert\n\n## Contributing\n\nWe appreciate you taking the initiative to contribute to this project.\n\nContributing 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.\n\n### Reporting a bug\n\nThink you’ve found a bug? We’d love for you to help us get it fixed.\nBefore 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.\n\n### Creating a pull request\n\nWant 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.\n\nOnce 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:\n\n1. Create a feature branch for each contribution.\n2. Submit your pull request early for feedback.\n3. Follow [PSR-2 Coding Standards](http://www.php-fig.org/psr/psr-2/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmehrshaddarzi%2Fwp-cli-reference-command","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmehrshaddarzi%2Fwp-cli-reference-command","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmehrshaddarzi%2Fwp-cli-reference-command/lists"}