alvis/magento2-twitter 1.0.0

Twitter feed.

Type

magento2-module

License

MIT

Requires
  • abraham/twitteroauth ^0.6.4
  • alvis/magento2-core ~1.0.0
Requires (dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Magento 2: Twitter

Twitter feeds using the most popular TwitterOAuth PHP library.

Multiple configuration options giving you full control over your tweets. Global integration option available along with an easy to use widget.

Installation

Recommended installation through composer, within your Magento root directory enter the following:

composer require alvis/magento2-twitter

Enable the module

php bin/magento module:enable Alvis_Core
php bin/magento module:enable Alvis_Twitter

You may also need to re-compile:

php bin/magento setup:upgrade
php bin/magento setup:di:compile

Create your Twitter app

You will need to create a Twitter app to get your API credentials. Please use the following steps as a guide:

  1. Go to https://apps.twitter.com and login using your Twitter account credentials
  2. Create a new application filling in your details. The Callback URL can be left empty
  3. Click on the 'Keys and Access Tokens' tab and then 'Create my access token'

Module configuration

The module configuration can be found through the main menu under Alvis. As a minimum please ensure you enter your screen name, consumer key, consumer key secret, access token and access token secret.

Display settings

Multiple settings available giving you full control over your tweets including:

  • Number of tweets to show
  • Show user follow button
  • Show the user screen name
  • Show the user profile image
  • Make URL links clickable
  • Show the reply link
  • Show the retweet link
  • Show the favorite link
  • Add rel="nofollow" for URL links
  • Make # tags clickable
  • Make @ tags clickable
  • Open links in a new window

Media settings

Multiple settings for when tweets include images:

  • Show media URLs, if set to no media URLs will be stripped from the tweet
  • Show media as clickable links not images
  • Show media as images not links
  • Select the media image size, thumbnail, small, medium or large

Search settings

Display tweets based off a search query, used when displaying searched tweets.

Integration

By default Twitter displays in the main content.

Extend the layout within your theme <VendorName>/<ThemeName>/Alvis_Twitter/layout/default.xml.

Move xml block:

<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <move element="alvis_twitter.latest" destination="footer" after="-" />
        <move element="alvis_twitter.mentions" destination="footer" after="-" />
        <move element="alvis_twitter.search" destination="footer" after="-" />
    </body>
</page>

Remove xml block:

<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceContainer name="main">
            <referenceBlock name="alvis_twitter.latest" remove="true" />
            <referenceBlock name="alvis_twitter.mentions" remove="true" />
            <referenceBlock name="alvis_twitter.search" remove="true" />
        </referenceContainer>
    </body>
</page>

Update xml block arguments:

<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="alvis_twitter.latest">
            <arguments>
                <argument name="title" xsi:type="string">New Block Title</argument>
            </arguments>
        </referenceBlock>
    </body>
</page>

Override the default templates within your theme create the following files:

<VendorName>/<ThemeName>/Alvis_Twitter/templates/tweets.phtml
<VendorName>/<ThemeName>/Alvis_Twitter/templates/widget/tweets.phtml

The original contents of the files can be found under:

<Root>/vendor/alvis/magento2-twitter/view/frontend/templates/tweets.phtml
<Root>/vendor/alvis/magento2-twitter/view/frontend/templates/widget/tweets.phtml

Widget

Alternatively you can use the Twitter Feed widget which has the following settings available:

  • Number of tweets to show
  • Title
  • Type of feed to show, latest tweets, mentioned tweets or search tweets
  • Search query

Styling

Currently no styling is provided with the module, please create your own.

Authors

Quick Links

Versions