The WordPress.org Plugin Directory

[jonathanbossenger]

Details

• Content type (Online Workshop, Lesson, Course, Tutorial, or Lesson Plan): Lesson
• Content title: The WordPress.org Plugin Directory
• Topic description: Introduce the WordPress.org Plugin Directory, reasons why developers might publish there, and provide an overview of the steps required to submit a theme.
• Audience (User, Developer, Designer, Contributor, etc.): Developer
• Experience Level (Beginner, Intermediate, Advanced, Any): Intermediate

Learning Objectives

• Explain what the WordPress.org Plugin Directory is
• Describe some of the benefits of publishing your plugin to the plugin directory
• Explain the steps required to submit a plugin

Related Resources and Other Notes

• https://wordpress.org/plugins/
• https://developer.wordpress.org/plugins/wordpress-org/
• https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/
• https://developer.wordpress.org/plugins/wordpress-org/plugin-developer-faq/

Automation Code

//lesson

[eirichmond]

Happy to contribute on this 👍

[github-actions[bot]]

Lesson Development Checklist

• [x] Gather any relevant links to Support, Docs, or related material
• [x] Description and Objectives finalized
• [ ] Lesson created and announced to the team for review
• [ ] Lesson reviewed
• [ ] Lesson video submitted and published to WPTV
• [ ] Lesson created on Learn.WordPress.org
• [ ] Lesson video published to YouTube
• [ ] Lesson on Learn.WordPress.org updated with YouTube video
• [ ] Lesson published to Learn.WordPress.org

[jonathanbossenger]

Draft script: https://github.com/wptrainingteam/learn-wp-content/blob/main/plugin-developer-learning-pathway/15-Publishing-Plugins/01-The-WordPress.org-plugin-directory.md

[jonathanbossenger]

@eirichmond thanks for your patience while I set up the lesson description and objectives, and complete the first draft of the script.

This script is very similar to the script for the Introduction to the WordPress theme directory, because there are a lot of similarities.

Feel free to review the script and suggest additions and/or improvements.

Let me know if you have any questions.

[eirichmond]

This is great work @jonathanbossenger thank you 🙏 Would it over complicate things to add another benefit of a hosted plugin in the repo means that users can also test drive your plugin in the playground?

[jonathanbossenger]

@eirichmond that's what I had in mind for the section on Plugin preview. Would it be better if we relabeld that as Live Preview, to match the button on the plugin page?

[eirichmond]

@eirichmond that's what I had in mind for the section on Plugin preview. Would it be better if we relabeld that as Live Preview, to match the button on the plugin page?

@jonathanbossenger I wasn't aware that you could Live Preview from the dashboard or the Repo, can you point me in that direction so I can see it in action?

My suggestion was more along the lines of, "Another benefit of hosting your plugin in the WordPress Plugin Repo means that it can also be tested by users in a Playground instance." for instance > https://playground.wordpress.net/?plugin=bbpress

[jonathanbossenger]

I wasn't aware that you could Live Preview from the dashboard or the Repo, can you point me in that direction so I can see it in action?

@eirichmond The Live Preview feature was initially added around a year or so ago, and then amended to be opt in a few months later.

If the plugin has a blueprints directory with a valid Playground blueprint.json file, a Live Preview button will be added to the plugin page in the directory. Example plugin here: https://wordpress.org/plugins/list-all-urls/

When enabled, the button opens an instance of the PLayground, with the plugin installed and configured as per the blueprint. You'll see with List all URLs; I've configured it to automatically open the plugin's settings page.

[jonathanbossenger]

👋 Hi @eirichmond I wanted to check in with you to see how it's going. Is there anything I can do to support you here?

[eirichmond]

Thanks for reaching out! All good here—apologies for the radio silence; I’ve had a few plates to spin recently. I fine-tuned the wording last week and have the audio ready, so I’m set to start video production and editing early next week.

[jonathanbossenger]

apologies for the radio silence; I’ve had a few plates to spin recently.

No worries, that's why I do check-ins 😄

I’m set to start video production and editing early next week.

Looking forward to it.

[eirichmond]

Hi @jonathanbossenger here is the first draft rendered, please let me know you're thoughts - I haven't shared this in slack yet, let me know if you'd like me to do that.

View the draft video here

[jonathanbossenger]

Thank you @eirichmond I will do my best to review this next week.

I'm away at a team meetup next week, but I would like to try and work on a script for #2758 while I'm away, so that you have something to work on next.

[rraventos]

I've reviewed the draft video following the Guidelines:

• [X] Learning outcomes/objectives are clear.
• [X] Technical concepts introduced in the content are accurate.
• [X] The speed of demonstrations are easy to follow.
• [X] The narration audio matches what is shown visually.
• [X] Spelling and grammar are correct.
• [X] Sound quality is consistent throughout the video.
• [X] Brand Usage Guidelines and Promotional Guidelines are being followed.
• [X] Media assets are all in the public domain (CC0).

The video covers all the aspects it should cover including the Plugin Live Preview suggested in a previous comment.

My only suggestion would be: When explaining the different points of why to publish a plugin on WordPress.org, or the steps to follow to install the plugin, the transition between the different points and steps, seems a bit abrupt to me. My suggestion is to pause a little before explaining a new point or step, and show them incrementally as shown in the lesson https://learn.wordpress.org/lesson/the-wordpress-org-theme-directory/: where you first show a slide with the title “Why publish in...” and the first point and then repeat this same slide adding the next point (I hope I have explained). This makes it easier to follow each point.

[benazeer-ben]

Hi Team,

Lessons Review Checklist

Please tick all items you've confirmed:

• [x] Learning outcomes/objectives are clear.
• [x] Technical concepts introduced in the content are accurate.
• [x] The speed of demonstrations are easy to follow.
• [x] The narration audio matches what is shown visually.
• [x] Spelling and grammar are correct.
• [x] Sound quality is consistent throughout the video.
• [x] Brand Usage Guidelines and Promotional Guidelines are being followed.
• [x] Media assets are all in the public domain (CC0).

The script and video looks good.

[dhaval6520]

Lessons Review Checklist

Please tick all items you've confirmed:

• [x] Learning outcomes/objectives are clear.

• [x] Technical concepts introduced in the content are accurate.

• [x] The speed of demonstrations are easy to follow.

• [x] The narration audio matches what is shown visually.

• [x] Spelling and grammar are correct.

• [x] Sound quality is consistent throughout the video.

• [x] Brand Usage Guidelines and Promotional Guidelines are being followed.

• [x] Media assets are all in the public domain (CC0).

[chekle]

Lesson Review Checklist

• [x] Learning outcomes/objectives are clear.
• [x] Technical concepts introduced in the content are accurate.
• [x] The speed of demonstrations are easy to follow.
• [x] The narration audio matches what is shown visually.
• [x] Spelling and grammar are correct.
• [x] Sound quality is consistent throughout the video.
• [x] Brand Usage Guidelines and Promotional Guidelines are being followed.
• [x] Media assets are all in the public domain (CC0).

For me, this was a great overview of the benefits of the WordPress.org plugin directory and how to submit a plugin. The lesson is concise and effective, and should answer many common questions for newcomers or first-time submitters.