Skip to content

πŸ™Œ Shortcode(s) to obtain resources from official GitHub API v3 and parsing README.MD WP GitHub API

License

Notifications You must be signed in to change notification settings

ahmadawais/WPGitHubAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

19 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

WPGitHubAPI

[wga] Shortcode to obtain resources from official GitHub API v3.

NOTE: WPGitHubAPI plugin uses transients to cache the counts for 24 * HOUR_IN_SECONDS.

Shortcode

  • [wga] shortcode accepts following parameters
    • u='api_url' where api_url is the part of API after https://api.github.com/ E.g. users/ahmadawais will return my profile data.
    • d='data' where data is the object's data you want to retrieve E.g. followers will return the number of followers for my profile.
    • GitHub Readme Parser with r='y' attribute in the shortcode.
    • Remove h1 with h1=y|n attribute in the shortcode.
    • Convert h1 to h2 with h2=y|n attribute in the shortcode.

Examples

Screenshot

To do

  • WGA shortcode
  • WGA Documentation

Updates

You can use GitHub Updater to receive updates for this plugin.

Changelog

Version 0.0.8

  • IMPROVE: Gracefully show the GitHub repo link on API rate limiting.

Version 0.0.7

  • IMPROVE: PHP 7 compat β€” thanks to @tfirdaus for PR #1.
  • FIX: PHP CS Issues like weird spacing and tabs.
  • NEW: Transients below 172 characters.

Version 0.0.6

  • NEW: Should there be h1 with h1=y|n.
  • NEW: Should convert h1 to h2 with h2=y|n.

Version 0.0.5

  • NEW: Basic PHPUnit tests.
  • NEW: GitHub Readme Parser with r='y' attribute in the shortcode.

Version 0.0.4

  • WP.org Repo submission.
  • NEW: README.txt.

Version 0.0.3

  • NEW: Custom transients names with API_URL and Data.
  • NEW: Regex Remove / in the beginning or at the end.

Version 0.0.2

  • FIX: Custom data related transients.

Version 0.0.1

  • First beta version.

License

Licensed under GNU GPL v2.0. Copyright (C) 2016 Ahmad Awais.


This open source project is maintained by the help of awesome businesses listed below. What? Read more about it β†’

About

πŸ™Œ Shortcode(s) to obtain resources from official GitHub API v3 and parsing README.MD WP GitHub API

Resources

License

Stars

Watchers

Forks

Packages