255 lines
8.2 KiB
Plaintext
255 lines
8.2 KiB
Plaintext
=== Include Mastodon Feed ===
|
|
Contributors: wolfgang101
|
|
Donate link: https://www.buymeacoffee.com/w101
|
|
Tags: mastodon, status, feed
|
|
Requires at least: 6.0
|
|
Tested up to: 6.7
|
|
Requires PHP: 7.4
|
|
Stable tag: 1.9.5
|
|
License: Expat License
|
|
License URI: https://directory.fsf.org/wiki/License:Expat
|
|
|
|
Plugin that provides a shortcode to easily integrate mastodon feeds into wordpress pages.
|
|
|
|
== Description ==
|
|
Plugin that provides an `[include-mastodon-feed]` shortcode to easily integrate mastodon feeds into wordpress pages. Supports personal and tag feeds.
|
|
|
|
The plugin is written in PHP and generates native JavaScript to fetch and render the mastodon feed. No special libraries needed.
|
|
|
|
== Installation ==
|
|
|
|
1. Upload the "include-mastodon-feed" directory to the "/wp-content/plugins/" directory.
|
|
1. Activate the plugin through the "Plugins" menu in WordPress.
|
|
1. Insert shortcode into any page.
|
|
|
|
= Shortcode example =
|
|
`[include-mastodon-feed instance="YOUR-INSTANCE" account="YOUR-ACCOUNT-ID"]`
|
|
|
|
= Shortcode attributes =
|
|
* **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
|
|
|
|
* **instance** (required)
|
|
Domain name of the instance without https:// (e.g. example.org)
|
|
|
|
* **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)
|
|
|
|
* **date-options**
|
|
Format options directly fed into toLocaleString() (Default: {})
|
|
|
|
= Additional customizations =
|
|
|
|
You can define several plugin constants to set custom default options that will be applied site-wide.
|
|
|
|
1. Open your `wp-config.php` file
|
|
2. Search for the line `/* Add any custom values between this line and the "stop editing" line. */`
|
|
3. 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.
|
|
|
|
|
|
== Frequently Asked Questions ==
|
|
|
|
= How do I find my account ID? =
|
|
Please feel free to use [this handy lookup tool](https://wolfgang.lol/code/include-mastodon-feed-wordpress-plugin/)
|
|
|
|
To look your ID up manually there are several ways.
|
|
|
|
As an instance admin you can easily read your user ID in the admin backend.
|
|
|
|
As regular user you can try an API v2 search to find your ID.
|
|
|
|
**API v2 notes:**
|
|
* Change `example.org` to your instance
|
|
* Replace `username` with your handle.
|
|
|
|
Use the following URL to get your ID:
|
|
|
|
`https://example.org/api/v2/search?q=username@example.org&resolve=false&limit=5`
|
|
|
|
|
|
|
|
= Known Issues / Todo =
|
|
* improve support for video and audio media attachment types
|
|
* integrate i18n into translate.wordpress.org instead of text constants
|
|
* re-build plugin as custom gutenberg block
|
|
|
|
== Screenshots ==
|
|
|
|
* No screenshots
|
|
|
|
== Changelog ==
|
|
|
|
= 1.9.5 =
|
|
* added option to either display smaller image media attachment previews (default) or large image versions
|
|
* 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 =
|
|
* Initial release
|
|
|
|
== Upgrade Notice ==
|
|
|
|
= 1.8.1 =
|
|
* minor style updates - if you have custom styling make sure to check if all is good
|
|
|
|
= 1.3.1 =
|
|
* 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
|
|
|
|
= 1.1.0 =
|
|
* "loading" shortcode attribute was renamed to "text-loading"
|