- Upload the "include-mastodon-feed" directory to the "/wp-content/plugins/" directory.
- Activate the plugin through the "Plugins" menu in WordPress.
- Insert shortcode into any page.
Shortcode example
[include-mastodon-feed instance="YOUR-INSTANCE" account="YOUR-ACCOUNT-ID"]
Shortcode attributes
- instance (required)
Domain name of the instance without https:// (e.g. example.org)
- account (required)
The account ID (a long number - see FAQ on how to get it)
- tag
Use tag instead of account if you want to embed a tag feed instead of a personal feed
- limit
Maximum number of statuses (Default: 20)
- excludeReplies
Exclude replies to other accounts (Default: false)
- excludeConversationStarters
Exclude statuses that start with a user mention (Default: false)
- excludeBoosts
Exclude boosted statuses (Default: false)
- onlyPinned
Show only pinned statuses (Default: false)
- onlyMedia
Show only statuses containing media (Default: false)
- preserveImageAspectRatio
Preserve image aspect ratio (Default: false)
- imageSize
Load small sized preview images or full size high quality images (Default: preview, full)
- imageLink
Link image to status or image (Default: status, image)
- tagged
Show only statuses that are tagged with given tag name (Default: false)
No leading #, case insensitive, e.g.: tagged="tagname"
- linkTarget
Target for all links e.g. new tab would be "_blank" (Default: _self)
- showPreviewCards
Show preview cards (Default: true)
- hideStatusMeta
Hide status meta information, automatically also hides date and time (Default: false)
- hideDateTime
Hide date and time from status meta information (Default: false)
- darkmode
Enable dark mode (Default: false)
- text-loading
Loading text (Default: Loading Mastodon feed...)
- text-noStatuses
Text if no statuses are available (Default: No statuses available)
- text-boosted
Text indicating boosted statuses (Default: boosted 🚀)
- text-viewOnInstance
View status on instance link text (Default: view on instance)
- text-showContent
Text for content warning buttons (Default: Show content)
- text-permalinkPre
Text before post permalink (date & time) (Default: on)
- text-permalinkPost
Text after post permalink (date & time) (Default: )
- text-edited
Text indicating edited posts (Default: (edited))
- date-locale
Locale for date string, used in toLocaleString() (Default: en-US)
Additional customizations
You can define several plugin constants to set custom default options that will be applied site-wide (e.g. date options can only be set as php constant to mitigate an XSS vulnerability).
- Open your
wp-config.php file
- Search for the line
/* Add any custom values between this line and the "stop editing" line. */
- Define the options you want to override between the line from step #2 and
/* That's all, stop editing! Happy publishing. */
See the included
config-example.php file for a full list of supported settings.
1.13
Special release for Global Accessibility Awareness Day
in collaboration with @oldrup@mastodon.green
Happy
Accesssibility Day
- accessibility (fix): image alt attributes - initial implementation was faulty
- accessibility: added alt text to image / gifv attachments
- accessibility: added alt text to avatar images
- accessibility: added alt text to preview card media
- accessibility: added descriptive aria-labels
- accessibility: increased default text / background color contrast
- accessibility: switched from DIV to semantic OL / LI structure
1.12
- accessibility: added image alt attribute (thank you @oldrup@mastodon.green)
1.11
- now favoring preview_url (smaler size) instead of remote_url (full size) for image previews (thank you @oldrup@mastodon.green)
1.10
- added image lazy loading for account and post images - post image lazy loading only works with preserveImageAspectRatio set to true (thank you @oldrup@mastodon.green)
1.9.11
- fixed typo (thank you @hjek)
- cleaned up code after 1.9.10 release
1.9.10
- fixed XSS vulnerability: removed support for date-options as shortcode attribute completely - to mitigate an XSS vulnerability where authenticated attackers with contributor permission could insert malicious JavaScript (still can be set as constant in PHP code)
1.9.9
- fixed esc_url context that previously broke the URL for the Mastodon API JS ajax request (thank you @beach@illo.social)
1.9.8
- fix broken date-locale and date-options parameters (thank you @crusy@chaos.social)
- improved string excaping for text parameters and added url escaping
- removed unnecessary output buffering
- fix license SPDX Identifier
1.9.7
- fix option to either display smaller image media attachment previews (default) or large image versions (thank you @beach@illo.social)
1.9.6
- fixed XSS vulnerability where authenticated attackers with contributor permissions could insert malicious JavaScript
1.9.5
- added option to either display smaller image media attachment previews (default) or large image versions (thank you @beach@illo.social)
- added option to point image media attachment links to either status (default) or image
1.9.4
- added option to hide status meta information and date/time (thank you @PaulKingtiger@dice.camp)
- added tag support - you can now embed tag feeds (thank you @martin@openedtech.social)
- added option to show embedded images in original aspect ratio (thank you @beach@illo.social)
- fix: correctly inject repeating emojis in display names and status texts (thank you @kanigsson@discuss.systems)
1.9.3
- fix: improved excludeConversationStarters detection (did not work correctly)
- fix: undid last refactor to load JS inline with markup instead footer to fix problem with JS that was added to footer even if shortcode was not visibly rendered
1.9.2
- fix: style for embedded videos / GIFs
- refactor: play gifv on mouseover
- refactor: load markup related javascript in footer instead of embedding it directly with the html markup
1.9.1
- refactor: show meaningful message if no statuses are available
- fix: broken excludeConversationStarters logic
1.9.0
- added option to exclude conversation starters (posts that start with a user mention)
1.8.1
- fix: boolean param validation was wonky
- fix: stop links from overflowing (thanks to https://github.com/moan0s for contributing)
- refactoring: improved styling of embedded images
1.8.0
- added option to show/hide preview cards
- refactoring: introducing plugin namespace
- refactoring: improved debug console output
1.7.0
- bumped tested wordpress version to 6.2
- added option to customize permalink text (before and after date/time)
- added option to customize text indicating edited posts
1.6.0
- image attachments are now clickable (link to original status)
1.5.0
- added option to show only statuses with specific tag
- added option to set link target to make links open in new tab
- added option to set maximum number of statuses
1.4.2
- fixed styling issue with emojis in account display name
1.4.1
- fixed styling issue with boosted account links
1.4.0
- removed "view on instance" link and made date info clickable instead
- added custom date locale and format option
- fixed emoji and inline link styling issues in content blocks
- fixed an issue with gifv media attachments
- refactored option sanitizing and filtering
1.3.1
- updated documentation that plugin constants for setting custom default options have to be defined in
wp-config.php, as the previous config.php file gets removed with every automatic plugin update
- removed
config.php support
1.3.0
- added new feed options: excludeReplies, onlyPinned, onlyMedia
1.2.0
- fixed broken JavaScript if post included media attachments other than images
- fixed custom "view on instance" option
- added option for custom content warning button text
- added option to exclude boosted statuses
- added support for gifv media attachments
1.1.0
- added support for more custom text overrides (loading, boosted, view on instnace)
- switched to showing static avatars, animated avatars only on hover
1.0.1
- escaped options when echoing them
- secured local file inclusion
- changed versioning to semantic versioning - now including patch number
1.0