In the continued spirit of sharing ordinary plugins to the WordPress repository, we posted Aviation Quotes a few years ago. It’s purpose is to simply return a random aviation quote on your website. We have a growing database of quotes and the plugin was designed primarily to service a few of our own aviation websites. It’s one of a few plugins we submitted only because we used them ourselves… and WordPress provided an easy means to maintain and update them.
One of the most limiting aspects of the current setup is that we’ll indiscriminately deliver a quote – comedic, serious, or otherwise. The ability to specifically request quotes of a specific nature hasn’t yet been implemented. The same applies for quotes that might be considered NSFW.
While there’s a WordPress plugin hosted in the WP repository, we’ve also provided shortcode and a PHP function.
The Result
The shortcode of [aviationquote p="1"] in your text editor will render the following on your WordPress website (blockquote is my own formatting):
“No data on air propellers was available, but we had always understood that it was not a difficult matter to secure an efficiency of 50% with marine propellers.” -- Orville Wright
The p=1 is used to wrap the quote in paragraph <p> tags. If not used the quote will display inline (as follows): “No data on air propellers was available, but we had always understood that it was not a difficult matter to secure an efficiency of 50% with marine propellers.” -- Orville Wright
WordPress shortcodes are easy to use. Even pilots can use them.
The individual receiving attribution for the quote can be formatted with standard HTML tags (if attribution exists). For example, to render the attribution text as bold and in italics, use the following: [aviationquote p="1" tags="em,strong"]. Note that the opening and closing tags aren’t used, and each html formatting instruction is separated by a comma.
“The important achievement of Apollo was demonstrating that humanity is not forever chained to this planet and our visions go rather further than that and our opportunities are unlimited.” – Neil Armstrong
We use an m-dash between the quote and attribution by default. You can alter this as follows: [aviationquote p="1" sep="~"]. The result:
“Nobody who gets too damned relaxed builds up much flying time.” ~ Ernest K. Gann, advice from the ‘old pelican’, The Black Watch, 1989
Again, the attribution will only be formatted if it is returned in the API response.
WordPress Shortcode
Copy and paste the WordPress function into your theme's functions.php file or, if you sensibly have one installed, your custom functions plugin. You may optionally download and install our plugin from the bottom of of the page.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 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 |
/* Display Aviation Quotes on Your Website With WordPress or PHP http://www.beliefmedia.com/aviation-quotes */ function beliefmedia_aviationquote($atts) { $atts = shortcode_atts(array( 'sep' => '—', 'tags' => false, 'p' => false, 'offline' => 'The Aviation Quotes <a href="http://www.beliefmedia.com/">API</a> is temporarily offline.', 'cache_temp' => 360, 'cache' => 3600, ), $atts); $transient = 'bmaq_' . md5(serialize($atts)); $cachedposts = get_transient($transient); if ($cachedposts !== false) { return $cachedposts; } else { /* Construct tag(s) for attribution */ if ($atts['tags'] !== false) { $tags = explode(',', $atts['tags']); foreach($tags as $tag) { $htmltag .= '<' . $tag . '>'; } $html_tags_closing = str_replace('<', '</', $htmltag); } /* Get quote from BeliefMedia API */ $json = @file_get_contents('http://api.beliefmedia.com/aviation-quotes/random.php'); if ($json !== false) $data = json_decode($json, true); if ($data['status'] == '200') { /* Get quote */ $thequote = (string) $data['data']['quote']; /* Attribution? */ $attribution = ($data['data']['attribution'] != '') ? $data['data']['attribution'] : false; /* Apply tags around attribution? */ if ( ($atts['tags'] !== false) && ($attribution != false) ) $attribution = $htmltag . $data['data']['attribution'] . $html_tags_closing; /* Attribution */ if ($attribution !== false) $attribution = ' ' . $atts['sep'] . ' ' . $attribution; /* String to return */ $result = ($attribution != false) ? $thequote . $attribution : $thequote; /* Wrap in paragraph tags? */ if ($atts['p'] !== false) $result = '<p>' . $result . '</p>'; /* Set transient */ set_transient($transient, $result, $atts['cache']); } else { $result = $atts['offline']; if ($atts['p'] !== false) $result = '<p>' . $result . '</p>'; set_transient($transient, $result, $atts['cache_temp']); } } return $result; } add_shortcode('aviationquote','beliefmedia_aviationquote'); |
If you require shortcode to work in a sidebar widget, you'll have to enable the functionality with a filter. If you're using our custom functions plugin, you'll have that feature enabled by default.
Shortcode Attributes
The following attributes can be used.
sep
sep is the separator between the text and the attribution. Defaults to em-dash (–).tags
tags="strong, em".p
p="1". We only built this in because of issues with WordPress that often prevents paragraph tags being applied.offline
offline="your text in here".cache_temp
cache_temp before making another request.cache
cache. We cache on our end for (usually) 20 minutes.PHP Function
Used outside of WordPress, the following function can be used. The function requires Simple Cache.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 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 |
/* Display Aviation Quotes on Your Website With WordPress or PHP http://www.beliefmedia.com/aviation-quotes */ function beliefmedia_aviationquote($args = '') { $atts = array( 'sep' => '—', 'tags' => false, 'p' => false, 'offline' => 'The Aviation Quotes <a href="http://www.beliefmedia.com/">API</a> is temporarily offline.', 'cache_temp' => 360, 'cache' => 3600 ); /* Merge $args with $atts */ $atts = (empty($args)) ? $atts : array_merge($atts, $args); $transient = 'bm_avquote_' . md5(serialize($atts)); $cachedposts = beliefmedia_get_transient($transient, $atts['cache']); if ($cachedposts !== false) { return $cachedposts; } else { $data = @file_get_contents('http://api.beliefmedia.com/aviation-quotes/random.php'); if ($data !== false) $data = json_decode($data, true); if ($data['status'] == '200') { /* Get quote */ $thequote = (string) $data['data']['quote']; /* Attribution? */ $attribution = ($data['data']['attribution'] != '') ? $data['data']['attribution'] : false; /* Apply tags around attribution? */ if ( ($atts['tags'] !== false) && ($attribution != false) ) $attribution = $htmltag . $data['data']['attribution'] . $html_tags_closing; /* Attribution */ if ($attribution !== false) $attribution = ' ' . $atts['sep'] . ' ' . $attribution; /* String to return */ $result = ($attribution != false) ? $thequote . $attribution : $thequote; /* Wrap in paragraph tags? */ if ($atts['p'] !== false) $result = '<p>' . $result . '</p>'; /* Set transient */ beliefmedia_set_transient($transient, $result); } else { /* Else we return old data */ $result = beliefmedia_get_transient_data($transient); } } return $result; } /* Usage */ echo beliefmedia_aviationquote(); |
To mimic the features of the shortcode, pass an array with ‘attributes’.
|
1 2 |
$args = array('tags' => 'strong', 'p' => 'true'); echo beliefmedia_aviationquote($args); |
Considerations
- The feature to submit new quotes from within your dashboard is now being tested by a few colleagues. Quotes are held for moderation and later make their way into the database.
Download
Shortt URL for this post: http://shor.tt/2nOv
