winter/wn-twitter-plugin

Twitter integration plugin for Winter CMS

Fund package maintenance!
LukeTowers

Installs: 343

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 1

Open Issues: 0

Type:winter-plugin

v2.0.0 2021-04-24 10:18 UTC

This package is auto-updated.

Last update: 2021-06-06 13:34:11 UTC


README

This plugin adds Twitter integration features to the Winter CMS.

This plugin allows you to add the following Components to your pages and layouts:

  • A Twitter Favourites list*
  • A Twitter Follow Button
  • A Twitter Tweet Button
  • A Twitter Embedded Tweet area
  • A Twitter Embedded Timeline area
  • Requires OAuth security

Configuring

Some features of Twitter use OAuth security. In order to use the plugin you need create a Twitter API application.

  1. Go to the Twitter Developers website to create a new application. You must be signed into Twitter in order to access the page.
  2. Click the Create New App button.
  3. Enter any application name, for example Winter CMS Twitter Integration.
  4. Provide a description for the application.
  5. Enter the website URL where the Twitter integration is going to be used.
  6. Read and agree to the "Rules of the Road"
  7. After the application is created, navigate to the API Keys tab and click the "Create my access token" button. Generating the access token could take some time. Keep refreshing the page until you see the "Your access token" section with the token and token secret strings.
  8. Return to the Winter CMS back-end and navigate to the Settings page.
  9. Click Twitter icon. Enter the API access information from the Twitter application page to the Twitter settings page in Winter CMS.
  10. Save the settings.

Displaying favorite Twitter messages

The plugin includes a component Favorites that lets you to output your favorite twitter messages on a page. Add the component to your page and render it with the component tag:

{% component 'twitterFavorites' %}

You can manage the number of favorite messages with the component settings. If you don't like the default favorite messages markup, don't use the component tag and just write your own code:

{% for favorite in twitterFavorites.all %}
    <blockquote>“{{ favorite.text_processed|raw }}”</blockquote>

    <p class="author">
        <img src="{{ favorite.user.profile_image_url_https }}"/>
        <span>{{ favorite.user.name }}</span>
        <a href="{{ 'http://twitter.com/'~favorite.user.screen_name }}">@{{ favorite.user.screen_name }}</a>
    </p>
{% endfor %}

See Twitter favorites API documentation for the information about available fields.