Making WordPress.org

Opened 5 weeks ago

Last modified 4 weeks ago

#7644 new enhancement

Add "Plugin Name" from plugin file to API response

Reported by: supersoju's profile supersoju Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

(This may apply to other endpoints, but I'm primarily focusing on plugins here)

On the wordpress.org API (https://codex.wordpress.org/WordPress.org_API), when querying for plugin metadata, I running into the issue where the plugin name is not actually available. Instead I'm only seeing the SEO'd title and not what would be shown in the plugin area within the WordPress admin area. Basically the difference between what's in the readme.txt and what's in the "Plugin Name" field in the plugin's main PHP file header.

For example, the plugin WP-Optimize (https://wordpress.org/plugins/wp-optimize/) shows up in the WordPress admin as "WP-Optimize - Clean, Compress, Cache", which is the "Plugin Name" field from the main plugin php file. However, the title on WordPress.org and in the API response is "WP-Optimize – Cache, Compress images, Minify & Clean database to boost page speed & performance", from the readme.txt.

There's lots of cases where these two are exactly the same, which is nice. But there's some instances where the readme.txt Title is almost unusable and it would be nice to have the shorter one available.

Basically this is a request to also include the "Plugin Name" field within the API response.

Change History (2)

#1 @jamieblomerus
4 weeks ago

I am not sure I quite see the need for this feature, but it's worth considering. It's important to note that the Plugin Directory API is meant to show the details of the Plugin Directory. Currently, the plugin name in the plugin's main file does not display in the directory, so I do not think this should be implemented for the Plugin Directory API at this time.

If we were to implement this into the Plugin Directory API, I think it should also be similarly implemented for the Theme Directory API.

#2 @dd32
4 weeks ago

  • Component changed from API to Plugin Directory

I'd personally like to ditch the different names, but that's not popular with many plugin authors for an obvious reason - #6106

Adding this field if there's no movement on the above makes sense though to me, but I feel like the underlying reason for this request is a reason why the above needs to move forward.

Note: See TracTickets for help on using tickets.