=== Log Out Shortcode ===
Tags: logout, shortcode, log-out, log out, link
Contributors: jamescollins
Requires at least: 3.9
Tested up to: 3.9.1
Stable tag: 1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Add a log out link to a post or page using a simple shortcode.

== Description ==

There are 3 shortcodes that can be used:

`[logout]` - A standard Log Out link, where the user stays on the login screen after being logged out.
`[logout_to_home]` - A link that logs the user out, and redirects them to your home page.
`[logout_to_current]` - A link that logs the user out, and redirects them back to the current page/URL.

**Advanced Usage:**

All 3 shortcodes all support 3 attributes/parameters:

`[logout text="" class="" redirect=""]`

The 3 supported attributes/parameters are:

`text=""`
- The text to use for the link anchor text.
- Default: `Log Out`
`class=""`
- The HTML class(es) to use for the link. Multiple classes should be separated by a space.
- Default: `logout`
`redirect=""`
- The URL to redirect the user to after they are logged out.
- Default: the WordPress login screen.

**Some Examples:**
`[logout text="Log Off"]` - A `Log Off` link that logs the user out.
`[logout redirect="/members/"]` - Log the user out, and redirect them to `/members/`.
`[logout_to_home text="Log Off"]` - A `Log Off` link that logs the user out and redirects them to your home page.
`[logout class="log-out-link"]` - Use a custom CSS/HTML class name for the log out link.


Note: the shortcodes will return nothing/empty if the user isn't logged in.


This plugin is inspired by the [Logout Button plugin by Ben Poland](http://wordpress.org/plugins/logout-button/).

== Installation ==

1. Activate the plugin.
1. Add one of the shortcodes to a post/page.

== Frequently Asked Questions ==

= What shortcodes can be used? =

Please see the [plugin description](http://wordpress.org/plugins/log-out-shortcode/) for a list of shortcodes and supported parameters.

== Changelog ==

= 1.0 =
* Initial release.