WordPress plugin that lets you use Discourse as the community engine for a WordPress blog
PHP Shell Other
Latest commit 5854661 Mar 24, 2017 @scossar scossar Update README

README.md

WP Discourse

OpenCollective OpenCollective

Note: the wp-discourse plugin requires >= PHP-5.4.0.

The WP Discourse plugin acts as an interface between your WordPress site and your Discourse community.

###Use Discourse for comments:

  • Automatically creates a forum topic for discussion when a new blog post is published.
  • Associates WP author accounts with their respective Discourse accounts. Does not require SSO.
  • Replies from the forum discussion can be embedded in the WP blog post. Select which replies to display based on post score and commenter "trust level" -- see docs.

See it live

###Single Sign On

The plugin also comes with optional SSO functionality which lets you use your WordPress site as the Single Sign On provider for your Discourse forum.

This will override Discourse's native (and powerful) login flow and is only recommended for use cases that strictly require such a setup, e.g. a site that is already using WordPress for large scale user management.

###Contact

Installation

From your WordPress dashboard

  1. Visit 'Plugins > Add New'
  2. Search for 'WP Discourse'
  3. Activate WP Discourse from your Plugins page

From wordpress.org

  1. Download WP Discourse
  2. Upload the 'wp-discourse' directory to your '/wp-content/plugins/' directory
  3. Activate WP Discourse from your Plugins page

With Composer

If you're using Composer to manage WordPress, add WP-Discourse to your project's dependencies. Run:

composer require discourse/wp-discourse ~1.3.2

Or manually add it to your composer.json:

{
  "require": {
    "php": ">=5.4.0",
    "discourse/wp-discourse": "~1.3.2"
  }
}

For more detailed instructions please see the setup page of the wp-discourse wiki

Frequently Asked Questions

Does this plugin install Discourse for me?

No this plugin acts as an interface between Discourse and WordPress. For it to work you will need to first set up Discourse forum. You can install Discourse for yourself following either of these guides:

Can I import old WordPress comments as Discourse comments (i.e. "replies")?

No.

Do WordPress and Discourse have to be installed on the same server?

The plugin uses the Discourse API, so your forum and blog can be hosted separately and the integration will still work. In fact, we strongly recommend hosting the two applications separately, since their hosting requirements are very different.

Is it possible to customize the comment templates?

Yes, the html templates used for publishing posts on Discourse and for displaying comments on WordPress can be customized in your theme. This is done by hooking into the filters that are applied to each template.

For more details on template customization, take a look at this section of our wiki: Template Customization

Contributing

  1. Fork this repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new pull request

Backers

[Become a backer]

Sponsors

[Become a sponsor]