GitHub Release Downloads
GitHub Release Downloads allows you to get the download count, links and more information for releases of GitHub repositories.
Download count
The shortcode is [grd_count]. It returns a number corresponding to the sum of all download count values for the selected releases. For instance, you can get the number of total downloads for one GitHub repository.
Attributes
user: the GitHub username.repo: the GitHub repository name.latest: only gets information about the latest published release for the repository.tag: only gets information about the release with the specified tag name.prereleases: includes draft releases and prereleases. Default value isfalse.
Examples
- All repository downloads:
[grd_count user="IvanRF" repo="MassiveFileRenamer"] - Latest release downloads:
[grd_count user="IvanRF" repo="MassiveFileRenamer" latest="true"] - Specific release downloads:
[grd_count user="IvanRF" repo="MassiveFileRenamer" tag="v1.6.0"]
Note: user and/or repo can be omitted if default values are set.
Release downloads list
The shortcode is [grd_list]. It returns an HTML list for the selected releases including the release tag name, the release description and the list of files that can be downloaded, like release assets or the source code.
For styling, class selectors are provided (e.g.: release-downloads-header, release-name, etc.).
Attributes
user,repo,latest,tag,prereleases: same as above.hide_description: hides the release description.hide_size: hides information about the file size.hide_downloads: hides information about the download count.downloads_suffix: use it for internationalization. Default value is" downloads".hide_source_code: hides the download link for the source code.
Examples
- All repository downloads:
[grd_list user="IvanRF" repo="MassiveFileRenamer"] - Latest release downloads:
[grd_list user="IvanRF" repo="MassiveFileRenamer" latest="true"] - Specific release downloads:
[grd_list user="IvanRF" repo="MassiveFileRenamer" tag="v1.5.6"] - Hide file size:
[grd_list user="IvanRF" repo="MassiveFileRenamer" hide_size="true"] - Hide downloads count:
[grd_list user="IvanRF" repo="MassiveFileRenamer" hide_downloads="true"] - Downloads suffix change:
[grd_list user="IvanRF" repo="MassiveFileRenamer" downloads_suffix="descargas"]
Boolean attributes can take any of this values: “1”, “true”, “on” and “yes”; or “0”, “false”, “off” and “no”.
Latest version
The shortcode is [grd_latest_version]. It returns the tag name of the latest published full release.
For tag names like “v1.6.0”, it returns “1.6.0” as the version number.
Attributes
user,repo,prereleases: same as above.
Settings
Under WordPress Settings menu you will find the GitHub Release Downloads options page. In this page you can set values for the GitHub username and the repository name to use by default in the shortcodes.
If both values are set, the shortcodes can be used without attributes (e.g.: [grd_count]) since default values for user and repo will be used.
Attribute values take precedence over default values. For example, [grd_count repo="MyRepo"] will use the username default value and the repository specified in the shortcode.
Download & install the zip archive
The plugin package installer can be downloaded from the WP2E project tab called “code”.
1 – Select the version to download if this option is available otherwise the “latest” version of the main plugin will be used.
2 – After downloading the zip archive install the plugin package installer in you local environment and activate the script from the plugin list.
3 – Under the section “Plugins” of the admin dashboard you should see a new “Dependencies & Licenses” link. Follow the instructions from this panel to finalize the installation of the missing dependencies.
-
- Give a name to your project
-
- Download the Installer Package
-
- Install & activate the plugin locally
-
- Install the suggested dependencies
Tips: Use the WP2E panel to add/suggest new dependencies to the local installation. Press F5 in the list of dependencies if the changes are not displayed right away.