WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#8880 closed feature request (fixed)

Add some extra data to output of Plugin API

Reported by: sivel Owned by: mdawaffe
Milestone: Priority: normal
Severity: normal Version:
Component: WordPress.org site Keywords:
Focuses: Cc:

Description

The plugin api seems to output everything except for those items that show on the other_notes section. Is it possible that the other_notes section could be added to the output of the plugin api?

Change History (6)

comment:1 DD325 years ago

  • Owner changed from matt to mdawaffe

I swear i had another ticket open for this.. But i cant find it. (Maybe I intended to open a ticket and forgot..)

Originally the "Other Notes" section WAS showing through, Well, Not as "Other Notes" but as "Changelog" "OTher Section" "Section2" (etc.). That seems to have changed though.

comment:2 johnbillion5 years ago

  • Summary changed from Add other_notes to output of plugin api to Add some extra data to output of Plugin API

+1 for this. Couple more small requests:

  1. Would be possible to add the screenshots data to the Plugin API too? I thought it was in there previously but has disappeared. Maybe there have been some updates to the Plugin API recently.
  2. It would be great to get the URL of the plugin author's wordpress.org profile page. For example mine is http://wordpress.org/extend/plugins/profile/johnbillion but there's no way to get this URL or even the slug or the username of the author.

comment:3 sivel5 years ago

  • Cc matt@… added

comment:4 johnbillion5 years ago

  • Keywords dev-feedback added

It seems that the screenshots section in the wp.org API was implemented but doesn't show up for all plugins.

For example the screenshots section is present for the plugin 'Public Post Preview' but not for 'Global Post Passwords'.

comment:5 mdawaffe5 years ago

  • Resolution set to fixed
  • Status changed from new to closed

Note that not all plugins have all sections.

That said, the following new (or fixed) things can now be returned by the API.

'author_profile' => profile_URL,
'contributors' => array( username => profile_URL, ... ),
'short_description' => short_description,
'sections' => array( section_name => section_text, ... ),
'description' => description_section_text

Available sections are "description", "installation", "faq", "screenshots", and "other_notes" (assuming the plugin has them).

You can ask for all three of short_description, sections, and description. sections['description'] will always be the same as description. short_description and description will sometimes be the same. short_description may also simply be a truncated version of description.

comment:6 johnbillion5 years ago

  • Keywords dev-feedback removed

Nice work mdawaffe, thanks

Note: See TracTickets for help on using tickets.