Search WordPress Docs
Search WordPress Docs is an extension that allows you to search functions, classes, methods, or hooks on the official WordPress documentation without having to leave VSCode.
How it Works
Search WordPress Docs takes the word at your cursor position, or selected text and matches it against a dictionary of known WordPress functions and hooks. If it recognizes your search term, it opens the according Documentation page https://developer.wordpress.org/, otherwise it opens Google's first result that matches.
Since version 2.0.0, results are shown on a panel to the right of your VSCode editor, and offers a few themes to style the results too. This is optional, and can be disabled from the extension's settings if you prefer to open the results on your browser.
To Make a Search
- Open/Create a PHP file. The extension ignores other languages.
- Place your cursor on a word you want to search, or manually select it, for example a function like
get_posts.
- When manually selecting text, select only a word, no symbols, or code blocks.
- Now you can choose how to invoke the search:
- Context Menu: Right click on the editor and click on "Search in WordPress Docs...".
- key Binding: Ctrl+Alt+F by default.
- Command Palette: You can do a search directly from the Command Palette, pressing Ctrl+Shift+P, then typing "WordPress" to filter the commands.
Documentation will appear on a side tab in VSCode. You can use the Table of Contents and the "Top ↑" links to navigate around the page, if you like. All other links will be opened in your browser.
Configuration
searchwpdocs.cssTheme: Choose between several themes to style the documentation when it is showed in a tab inside VSCode.searchwpdocs.openResultsInTab: Enabled by default, it shows the documentation in a tab inside VSCode. If it is disabled, documentation will open in your browser instead.searchwpdocs.showOnSideTab: Allows you to specify whether you want documentation to open on a side panel or as a regular tab. You can of course drag and drop the tab after it opens and rearrange it as you like.searchwpdocs.site: Change the url to use for the search when the word isn't recognized by the extension. The text you have selected will be appended to the url specified here. With this setting you can choose if you want to search in the Developer Reference site, in the good old Codex, or other sites like QueryPosts.
Known Issues
If a word is not found in the internal dictionary, the extension will rely on Google's "I'm feeling lucky" functionality to show the best guess match, so results might be less accurate in that case. This should rarely happen when searching for functions and hooks.
When showing results in VSCode, only results from the Developer Reference site will be shown. Other documentation sources such as the Codex are not available in this mode.
If you set the search site in settings to the WordPress Codex, some functions will still redirect to the new Developer Resource site. This is out of the control of this extension, as the Developer Resource is meant to replace the older Codex site.
Roadmap
Planned updates can be found at the project's Trello board.
Suggestions & Bug Reports
If you find an issue or have any feedback you can let me know by posting on github.
Themes
Search WordPress Docs has a few themes available, used to style the Documentation when viewed in a tab within VSCode.
If you want to help by providing a theme, check this guide, thanks.
List of Themes
- WordPress Code Reference
- One Dark
- Monokai
Release Notes
2.0.1 - 2019-06-22
- Troubleshooting error with request module.
2.0.0 - 2019-06-21
- Added feature to view documentation inside VSCode.
- Added themes 'WPDocs', 'One Dark' and 'Monokai' for documentation.
- Fixed keyboard shortcut not working when trying to invoke search without a selection.
1.1.2 - 2019-06-18
- It is no longer necessary to select a word, if nothing is selected the extension will search the word at the cursor position.
1.1.1 - 2018-08-14
- Fix default google search parameter, changed from 'url' to 'site'. Thanks to 'soderlind' for reporting the error.
1.1.0 - 2018-05-16
- Added configuration setting to select where to do the search (Developer Reference, Codex, etc..).
- Reduced the amount of commands to one, now that it can be customized.
1.0.0 - 2018-05-11
- Initial release of Search WordPress Functions.
