Plugin Update Checker JSON API
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

 
View only
 
 
Still loading...
ABCDEFGHIJKLMNOPQRSTU
1
FieldTypeDescriptionExampleRequiredUsed in
2
namestringThe name of the plugin."Example Plugin"RequiredPlugin information
3
slugstringA lower-case string that uniquely identifies the plugin."example-plugin"OptionalUpdates and plugin information.
4
versionstringThe version number of the latest release."1.2.3"RequiredUpdates and plugin information.
5
download_urlstringThe download URL for the latest version of the plugin. This URL must point to a valid ZIP file that's structured in the same way as the plugin ZIPs from the official WordPress.org plugin directory. Specifically, the .zip archive should contain a single directory whose name matches the plugin's slug. The rest of the plugin's files should be contained within that directory."http://example.com/example-plugin.zip"RequiredUpdates and plugin information
6
sectionsobjectThis field specifies the captions and contents of all tabs displayed in the "Plugin Information" dialog. Each sub-field becomes a new tab, with the field name as the caption and the field value as the tab's contents. When converting field names to tab captions, WordPress will automatically replace any underscores with spaces and upper-case the first letter of each word. For example "installation_notes" will become "Installation Notes".

HTML is allowed in all sections, but certain tags may be filtered out. Alas, I can't be bothered to pore through the WP source to find out which those are. At the very least, paragraphs, basic typography and lists appear to work fine.

The only required entry is 'description', but you can also specify any number of other tabs. Common examples are 'changelog' and 'installation'.
{
"description" : "foo",
"changelog" : "bar",
"custom_section" : "<em>baz</em>"
}
RequiredPlugin information
7
homepagestringPlugin's home page URL."http://example.com/"OptionalUpdates and plugin information.
8
requiresstringThe lowest version of WordPress that the plugin will work on."3.5.1"OptionalPlugin information
9
testedstringThe highest version that you've successfully used to test the plugin."4.5"OptionalPlugin information
10
authorstringAuthor's name."John Smith"OptionalPlugin information
11
author_homepagestringAuthor's homepage URL"http://example.com/"OptionalPlugin information
12
last_updatedstringA date string indicating when the plugin was last updated. It is usually specified as YYYY-MM-DD, but other date/time formats may also work."2016-05-05 18:11:00"OptionalPlugin information
13
upgrade_noticestringA short description of why the user should upgrade. According to the readme.txt docs on WordPress.org, this field should be no more than 300 characters."Arbitrary text here"OptionalUpdates
14
ratingfloatThe average user rating for the plugin, on the scale of 1 to 100. This field generally makes no sense for plugins not hosted on WordPress.org and thus can be safely omitted.75OptionalPlugin information
15
num_ratingsintThe number of users who've rated the plugin. Again, this field can be safely omitted.123OptionalPlugin information
16
downloadedintThe number of times the plugin has been downloaded. Like 'rating' and 'num_ratings', this field will be useless for most privately hosted plugins - but it's there if you want it.456OptionalPlugin information
17
active_installsintThe number of sites that use the plugin. Note that plugins hosted on wordpress.org only report approximate stats - for example, 10000 instead of 12450. It's up to you whether you want to do the same, report the exact number of installs, or omit this field entirely.10000OptionalPlugin information
18
bannersobjectThe URL of the plugin banner. The banner will be displayed at the top of the "View version 1.2.3 details" pop-up.

The "banners" object should contain two fields - "low" and "high". The "low" field must contain a URL that points to a 772x250 pixel image (PNG or JPG). The "high" URL must point to a 1544x500 version of the same image (this will be used on high-DPI screens). Only one of "low" or "high" is required.
{
"low" : "http://example.com/banner-772x250.png",
"high" : "http://example.com/banner-1544x500.png"
}
OptionalPlugin information
19
translationsarrayA list of available language packs. Language packs are translations that can be installed and updated independently the plugin itself. See wordpress.org documentation on plugin internationalization for more details.

The "translations" array should contain zero or more objects with the following fields:

"language" - gettext locale name.

"updated" - Translation update timestamp. Any format that's supported by PHP's strtotime() function will work, but the timestamp must be correct or translation updates won't work properly.

"package" - The URL of the language pack. It must be a ZIP archive that contains two files: "plugin-slug-aa_BB.po" and "plugin-slug-aa_BB.mo" (where "aa_BB" is the locale name).

"version" - The plugin version that this translation applies to. Optional. At the time of this writing, WordPress didn't actually use this version number for anything.
[
{
"language" : "fr_FR",
"updated" : "2015-04-22 23:22:42",
"package" : "http://example.com/example-plugin-fr_FR.zip",
"version" : "1.0"
},
{
"language" : "de_DE",
"updated" : "2016-05-05 16:48:00",
"package" : "http://example.com/another-translation.zip",
"version" : "2.0"
}
]
OptionalTranslation updates
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Loading...
 
 
 
Sheet1