FYI, Daisy Olsen is going to head up the theme developer handbook. She’s started working on an initial outline/TOC. Anyone want to volunteer in advance to help with it?
Tagged: handbooks Toggle Comment Threads | Keyboard Shortcuts
I’ll be working on an outline for the core contributor handbook in the coming weeks, so I figured I would start a brainstorming session here. Some potential questions to ask yourself:
- What do core contributors need to know?
- What would have been great to know when you first started getting involved?
- What resources (such as pages on the Codex) have you found useful?
- What do people (including/especially non-contributors) need to know about the development process/cycle/philosophies?
Thank you to everyone that commented and help me brainstorm what is needed for a good plugin developer handbook. Â I’ve synthesized that information and have come up with the following chapter list / section plan behind the jump. Â Please let me know if there is anything you think I missed. Â Remember, this handbook is designed specifically for the task of Plugin development. Â It’s not designed to be the end all, be all guide to WordPress. Â It’s designed to help new plugin developers get to the point that they can build a plugin and assist existing plugin developers with finding the best practices for doing things.
The next step is going to be to find authors for all of these sections. Â I’m going to be reaching out to a number of people to help out, but I’d also love to see some people volunteer. Â Please contact me @aaronjorbin on twitter or jorbin in IRC if you think you might be interested in writing a chapter or section. I’m going to be leaning on many of you, the experienced core developers and plugin developers.
I’ve started brainstorming ideas for the plugin developer handbook and have come up with a pretty long list of topics that I think should be covered. Some of these will be chapters on their own, some will be combined together and others still need to be thought of. For right now, the best feedback you could give me is to tell me what I missed and what you think might be out of scope.
A couple of notes:
- I tried to include chapters so that both novice and experienced developers will be able use it. Hence ideas such as knowing the difference between the different languages used in WordPress.
- Some things, while listed, I think will include warnings and language that discourages it. The two that stand out to me are: Custom database tables and Custom Option Pages.
Alright, now for the list:
- Languages of WP – Differences between PHP, HTML, CSS, JS
- WP Coding Standards
- Organizing plugin files
- Planning your plugin
- Name Spacing
- Adding Styles and Scripts
- Actions / Filters
- How to use them
- How to add them to your theme so other plugins can use them
- Front End Forms
- Front end ajax
- Back End ajax
- Roles and Capabilities and users
- Custom caps
- User Meta
- Comment Meta
- interacting with comment filters
- Adding options to existing admin pages
- Adding your own pages
- Translating / Internationalization
- Custom Taxonomies
- Custom Post Types
- Scheduled events (pseudo-cron)
- Activation / Removal hooks
- Interacting with the database
- Adding Tables / interacting with them
- Capabilities check
- Nonces – Props Eric
- Interacting with remote URLs
- atom / rss
- Interacting with WP_Query
- Media and Post relations (Send to editor)
- Modifying / Creating URLs
- MultiSite specific Compatibility
- General Tips / Tricks / Notes (Ideally a tip or two from many different devs)
- Adding Admin Notices
- Giving your plugin the WordPress look (Hopefully the style guide will be finished before then).
- Pluggable Functions
- Admin Meta Boxes
- Dashboard Widgets
- Extending Tiny MCE
- A Good Development Environment
- Development Process