Flattr Widget V0.1


Here it is, my first ever plug-in for WordPress. Please note that this is a very early release beta and there may be bug and there will be improvements to be made.

Click here to Download Version 0.1

Description

This is a widget that allows you to quickly and easily create a flttr widget within posts and pages using a simple shortcode. The advantage of having a shortcode is that it can be customised for every use. The short code has lots of customisability and can be used in a very basic way or with more advanced features.

The way the widget works is that within a post or page you include the shortcode and then that shortcode will generate all the javascript needed to embed the widget. That means you don’t need any knowledge of coding or js. As opposed to the official Flattr Widget, you do not need to embed a php function to get the widget or have it included in every post. You can call the shortcode from within a post or page and the most important thing is that you have the option to customise the widget every time! This does not mean that the official Flattr Widget does not have its place, and I actually recommend using both in conjunction!

This means that you can insert widgets that will Flattr pages other than the one you are on (for example some external content) and it will also allow you to set the Flattr User ID per widget meaning you can have multiple widgets for multiple people, or allow blogs that have multiple authors to add a Flattr widget that will flattr them (rather than the site) for their content.

How to Use

There are a few ways that the Widget can be used going up in complexity.

Super Simple (Requires official Flattr Plugin)

Super Simple Shortcode

Super Simple Shortcode

There are various ways that the Flattr Widget can be used. The most simple is to just include the code in the image on the right anywhere in a post. Using this will require that you have the official Flattr Widget installed and have set your Flattr UID on that (an independent setting will come in a later version).

Settings will be automatically set as stated:

  • The button type will be set to large
  • The User ID (as mentioned above) will be set to that which is set up in the official plugin
  • The title will be set to the Page/Post title
  • The description will be set to the Page/Post excerpt
  • The category will be set to text
  • The language will be set to English
  • Tags will not be set
  • The url will be set to the Page/Post’s permalink
  • The thing will not be hidden from listings on flattr.com

In a future build, some of these default settings will be customisable.

Simple

Simple Shortcode

Simple Shortcode

Simple is the most simple way of using my Flattr Widget if you do not have/want to install the official Flattr Plugin. It is also what you would use if you have multiple bloggers blogging on the same blog and each want to earn their own Flattry. To use this option, use the code shown in the image on the left replacing {uid} with your Flattr User ID. The only difference between this simple option and the super simple option is that you are defining your Flattr User ID independently.

Settings will be automatically set as stated:

  • The button type will be set to large
  • The User ID will be set to whatever you have defined as {UID} in the shortcode
  • The title will be set to the Page/Post title
  • The description will be set to the Page/Post excerpt
  • The category will be set to text
  • The language will be set to English
  • Tags will not be set
  • The url will be set to the Page/Post’s permalink
  • The thing will not be hidden from listings on flattr.com

In a future build, some of these default settings will be customisable.

Advanced… but still pretty simple!

Finally, there is the advanced option. You can use the advanced shortscode shown bellow. All variables are optional (defaults will be used if left blank). If, for example, you wanted the default url you could exclude all ” url='{uid}’ ” and the default would be used. Leaving a variable empty will also result in the default being used but it is probably best practise to remove variables you are not going to be using. Note that if you do not set {uid} you do not need the final “[/flattr]“

Advanced Shortcode

Advanced Shortcode

To use edit the shortcode you should change the parameter values (indicated with curly brackets surrounding them). The parameters are:

  • btn – This is the type of button you would like to display. To get the compact button use ‘compact’ otherwise the default (large) button is displayed.
  • uid – This is your personal user id. If not defined, it will be set to that which is set up in the official plugin providing that is set up and installed, otherwise the widget will fail!
  • tle – This is the title of the thing you want to submit. This is typically the title of your blog entry or software name. If undefined the title of your Post/Page will be used.
  • dsc – This is the full excerpt of the content. Some blog text or information about your song you’ve written or so forth. If undefined excerpt title of your Post/Page will be used.
  • cat – This is the flattr category the content belongs to. You can choose between the following: text, images, video, audio, software, rest. If undefined text will be used.
  • lng – Language of the submitted thing. List of available languages. If undefined Enlgish (en_gb) will be used.
  • tag – This is the tags of the thing, to help people finding your content easier on the Flattr website. If you want to use multiple tags, separate using a normal comma (,) sign. If undefined no tags will be used.
  • url – This is the URL of the thing, if this is not always the same on your site. Maybe you have multiple domains with the same content. This is to lock the content to always be recognized as the same content for Flattr. If undefined the permalink of your Post/Page will be used.
  • hide – Use this to hide the thing from listings on flattr.com. The value ‘true’ or ‘t’ will hide the thing. If undefined the the thing will be shown on listings on flattr.com.

Download

Click here to Download Version 0.1

Flattr Me

If you use my plugin, you can show your appreciation by flattring me:

Bugs

Please report bugs in the comments

Known Bugs

  • Can affect the size of some of the widgets created using the official plugin (change some from large to compact)

Features

If there are any features you would like then please request them in the comments

Features in development

  • Configuration page with custom default settings
  • Graphical shortcode generator

Leave a Reply