Latest Developments
RicheyWeb
​​Bespoke, No Joke.

Documentation

System - X Autopost

5.0.27 Overview

The System - X Autopost plugin for Joomla is a powerful tool designed to enhance the social media presence of Joomla websites by automating the generation of Twitter/X Cards and posting content to X/Twitter. This plugin seamlessly integrates with Joomla’s content management system, enabling site administrators to share articles (com_content) and contact profiles (com_contact) with rich, customizable previews that improve engagement on X/Twitter. As of October 10, 2025, the plugin supports a range of Twitter/X Card types, including Summary, Summary Large Image, App, and Player, with advanced configuration options for metadata and media embedding.

Overview of Purpose and Capabilities

The primary purpose of the System - X Autopost plugin is to streamline social media integration for Joomla websites. Its key capabilities include:

  • Twitter/X Card Generation: Creates rich metadata previews (Twitter/X Cards) for shared links, supporting Summary, Summary Large Image, App, and Player card types.
  • Automated Posting: Automatically posts Joomla content to X/Twitter when articles or contacts are created or updated, using Twitter API credentials.
  • Flexible Configuration: Offers global defaults and per-content-item overrides for tweet content and card metadata, configurable via Joomla’s admin interface.
  • Context-Specific Metadata: Tailors metadata for articles and contacts, pulling from fields like titles, descriptions, images, or custom inputs.
  • Media Embedding: Provides video and audio templates for Player cards, with support for self-hosted streams and customizable output.
  • Category Filtering: Allows inclusion or exclusion of specific categories for autoposting, supporting fine-grained control over content sharing.
  • Caching: Optimizes performance by caching Twitter/X Card data, leveraging Joomla’s cache system.
  • Extensibility: Modular design with support for additional Joomla components and custom metadata logic.

Key Benefits

  • Enhanced Social Media Engagement: Twitter/X Cards provide visually appealing previews, increasing click-through rates and user interaction on X/Twitter.
  • SEO Optimization: Structured metadata improves how content is indexed and displayed on social platforms, potentially boosting search engine visibility.
  • Time-Saving Automation: Eliminates manual posting by automatically sharing new or updated content to X/Twitter.
  • Customizable Previews: Offers granular control over tweet text and card metadata, ensuring brand consistency and tailored messaging.
  • Performance Efficiency: Caching reduces server load and speeds up metadata generation for high-traffic sites.
  • User-Friendly Interface: Leverages Joomla’s familiar admin interface for easy configuration, even for non-technical users.

Tweet Text Length and Truncation

The System - X Autopost plugin enforces a maximum tweet length of 280 characters to ensure proper display of Twitter/X Card previews. Tweets are constructed from the content’s title, description, and/or custom text, along with a URL linking to the content. If the combined text exceeds 280 characters, the URL may be pushed past X/Twitter’s "Read more" link, preventing the Twitter/X Card preview from displaying. To avoid this, the plugin removes newlines, extra spaces, and trims text to fit within the 280-character limit, prioritizing content clarity and card visibility. The optional Ellipsis feature adds "..." to truncated text, visually indicating that content was shortened. This enhances user experience by signaling that additional content is available on the linked page. Enable the Ellipsis feature in the plugin’s configuration to improve tweet readability.

The plugin will never cut a word in half, truncation always occurs at a word boundary.

System Requirements

To ensure the System - X Autopost plugin functions correctly on your Joomla website, the following system requirements must be met. These requirements align with the plugin’s dependencies and the Joomla ecosystem as of October 10, 2025.

Joomla Version Compatibility

  • Supported Versions: Joomla 4.x or 5.x

Twitter/X Developer Account for API

  • Requirement: A Twitter/X Developer Account with valid API credentials is required for autoposting functionality.
  • Credentials Needed:
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret
  • Setup Process:
  • Notes:
    • Autoposting is optional and can be disabled by leaving the credential fields empty.
    • Twitter/X Card generation (metadata for link previews) does not require API credentials and works independently.

Optional Caching Setup

  • Caching: Joomla’s caching system is recommended for performance optimization.
    • The plugin supports caching of Twitter/X Card data to reduce database queries and improve page load times.
    • Cache settings use Joomla’s global cache configuration (default group: plg_system_xautopost, lifetime based on Joomla’s cache time setting).
  • Requirements:
    • Joomla caching must be enabled (via Global Configuration > System > Cache Settings).
  • Notes: Caching is optional but highly recommended for high-traffic sites to minimize server load during metadata generation.

Installation

This section provides a step-by-step guide to installing the System - X Autopost plugin on your Joomla website. The process involves downloading the plugin, installing it via the Joomla Extension Manager, and verifying that it is properly installed and enabled. These instructions are accurate as of October 10, 2025.

Downloading the Plugin

  1. Obtain the Plugin Package:
    • Visit the official source for the System - X Autopost plugin, available at https://www.richeyweb.com.
    • Download the plugin package, which should be a ZIP file named plg_system_xautopost-v*.zip or similar.
  2. Verify the Package:
    • Ensure the downloaded file is compatible with your Joomla version (4.x or 5.x).
    • Check the file integrity (e.g., using a checksum if provided by the source) to confirm it is not corrupted.

Installing via Joomla Extension Manager

  1. Access the Joomla Admin Panel:
    • Log in to your Joomla website’s administrator backend (e.g., yourwebsite.com/administrator).
  2. Navigate to the Extension Manager:
    • Go to System > Install > Extensions in the Joomla admin menu.
  3. Upload the Plugin Package:
    • In the Upload Package File tab, click Choose File (or equivalent) and select the plg_system_xautopost-v*.zip file from your computer.
    • Click Upload & Install to begin the installation process.
  4. Confirm Installation:
    • Upon successful installation, Joomla will display a confirmation message indicating that the plugin has been installed.
    • If errors occur, ensure the ZIP file is valid, your server meets the system requirements, and you have sufficient permissions.

Verifying Installation and Enabling the Plugin

  1. Check Plugin Installation:
    • Navigate to System > Manage > Plugins in the Joomla admin panel.
    • Search for “System - X Autopost” in the plugin list.
    • Confirm that the plugin appears with the type “System” and the name “System - X Autopost.”
  2. Enable the Plugin:
    • If the plugin is not already enabled, locate “System - X Autopost” in the plugin list.
    • Click the status icon (red circle with an “X” for disabled) to enable it. A green checkmark indicates the plugin is active.
  3. Initial Configuration Check:
    • Go to System > Manage > Plugins, then click on “System - X Autopost” to access its configuration.
    • Ensure the plugin’s settings tabs (e.g., Credentials, Tweet Defaults, Card Defaults, Coverage) are visible and accessible.
    • Optionally, configure Twitter/X API credentials and other settings (see Section 4 for API setup and Section 5 for global configuration).

API Setup

The System - X Autopost plugin requires Twitter/X API credentials to enable automatic posting of Joomla content (articles and contacts) to X/Twitter. This section outlines how to obtain these credentials, configure them in the plugin’s admin interface, and disable autoposting if needed. These instructions are accurate as of October 10, 2025.

Obtaining Twitter/X API Credentials

To enable autoposting, you must acquire the following credentials from the Twitter/X Developer Portal: Consumer Key, Consumer Secret, Access Token, and Access Token Secret. Follow the steps detailed in X API Setup Walkthrough for System - X Autopost.

Configuring Credentials in the Plugin’s Admin Interface

Once you have the API credentials, configure them in the Joomla admin interface to enable autoposting:

  1. Access the Plugin Settings:
    • Log in to your Joomla administrator backend (e.g., yourwebsite.com/administrator).
    • Navigate to System > Manage > Plugins.
    • Search for and click on “System - X Autopost” to open its configuration.
  2. Enter API Credentials:
    • Locate the Credentials tab in the plugin’s configuration.
    • Enter the following fields:
      • Consumer Key: Paste the Consumer Key from the Twitter/X Developer Portal.
      • Consumer Secret: Paste the Consumer Secret.
      • Access Token: Paste the Access Token.
      • Access Token Secret: Paste the Access Token Secret.
    • These fields correspond to the settings defined in the plugin’s language file (plg_system_xautopost.ini).
  3. Save and Test:
    • Click Save or Save & Close to store the credentials.
    • To verify the setup, create or update a test article in a category that is enabled in Coverage or contact and check if it autoposts to your X/Twitter account.

Disabling Autoposting by Removing Credentials

If you wish to disable autoposting while still using Twitter/X Card generation for link previews:

  1. Clear Credential Fields:
    • Return to the Credentials tab in the plugin’s configuration (System > Manage > Plugins > System - X Autopost).
    • Remove the values from the Consumer Key, Consumer Secret, Access Token, and Access Token Secret fields.
    • Alternatively, set these fields to empty strings.
  2. Save Changes:
    • Click Save or Save & Close to apply the changes.
    • The plugin will no longer attempt to autopost content to X/Twitter, but Twitter/X Card metadata generation will continue to function for link previews.
  3. Notes:
    • Disabling autoposting does not affect existing Twitter/X Card configurations stored in the database.
    • You can re-enable autoposting at any time by re-entering valid API credentials.

Notes

  • Security: Store API credentials securely and avoid sharing them publicly. Treat them like passwords, as they grant access to your X/Twitter account.
  • API Limits: Be aware of Twitter/X API rate limits, which may affect autoposting frequency on high-traffic sites. Check the Developer Portal for current limits.
  • Troubleshooting: If autoposting fails, verify credential accuracy, app permissions, and network connectivity.

Global Configuration

The System - X Autopost plugin provides a robust set of global configuration options to control how Twitter/X Cards are generated and how content is autoposted to X/Twitter. These settings, accessible through the Joomla admin interface, define default behaviors for coverage, tweet content, and card metadata. They can be overridden on a per-content-item basis (see Section 6). This section details the configuration options for Coverage Settings, Tweet Defaults, and Card Defaults, accurate as of October 10, 2025.

Coverage Settings

Coverage settings determine which Joomla components and categories are included in or excluded from autoposting and Twitter/X Card generation.

Selecting Components

  • Purpose: Specifies which Joomla components the plugin processes for autoposting and card generation.
  • Configuration:
    • Navigate to System > Manage > Plugins > System - X Autopost in the Joomla admin panel.
    • In the Coverage tab (defined in coverage.xml), select a component from the Component dropdown.
    • Options:
      • com_content: Joomla articles.
      • com_contact: Joomla contact profiles.
      • Additional components like com_newsfeeds, com_weblinks, and com_tags are planned for future support.
    • Default: Must select at least one component (required field).
  • Notes:
    • Only selected components will trigger autoposting or card generation.
    • Ensure the selected components are active on your Joomla site.

Including/Excluding Categories

  • Purpose: Filters content within selected components by category, allowing inclusion or exclusion of specific categories.
  • Configuration:
    • In the Coverage tab, use the Exclude Categories radio button to choose:
      • No (default): Selected categories are included for autoposting.
      • Yes: Selected categories are excluded from autoposting.
    • Select categories for each component (e.g., com_content_category, com_contact_category) using the multi-select category fields.
      • These fields use Joomla’s category picker with a fancy-select layout.
      • If no categories are selected, all categories for the component are included by default.
  • Notes:
    • Use this to target specific content (e.g., only blog articles) or exclude unwanted content (e.g., private categories).
    • Category settings apply to only autoposting, not Twitter/X Card generation.

Tweet Defaults

Tweet defaults control the default content and structure of tweets posted to X/Twitter when new or updated content is saved.

Configuring Default Tweet Options

  • Purpose: Determines whether the title and description are included in autoposted tweets by default.
  • Configuration:
    • In the Tweet Defaults tab, configure:
      • Show Title:
        • Yes (default): Includes the content’s title (e.g., article title, contact name) in the tweet.
        • No: Excludes the title.
      • Show Description:
        • Yes (default): Includes a description (e.g., article meta description, contact miscellaneous text) in the tweet.
        • No: Excludes the description.
    • Default Behavior:
      • Titles and descriptions are trimmed to fit within X/Twitter’s 280-character limit (handled by compressTrimText in XMeta.php).
      • Descriptions are sourced based on the component (e.g., article meta description for com_content, miscellaneous text for com_contact).
  • Notes:
    • These settings can be overridden per content item (see Section 6).
    • Enabling both title and description maximizes tweet content but may require truncation.

Card Defaults

Card defaults define the default Twitter/X Card type and metadata for content, ensuring consistent link previews on X/Twitter.

Setting Default Card Type

  • Purpose: Specifies the default Twitter/X Card type used when no per-item override is set.
  • Configuration:
    • In the Card Defaults tab (defined in carddefaults.xml), select a Card Type from the dropdown:
      • Summary: Displays a title, description, and small thumbnail.
      • Summary Large Image (default): Similar to Summary but with a larger image.
      • App: Promotes mobile apps with app store details.
      • Player: Embeds playable media (video/audio).
    • Default: summary_large_image.
  • Notes:
    • For com_contact, only summary and summary_large_image are supported.
    • The player type supports a custom modification where a self-hosted player is activated if the player field is empty but the stream field contains a local file.

Configuring Default Metadata

  • Purpose: Sets default values for Twitter/X Card metadata fields, used when no per-item overrides are provided.
  • Configuration:
    • In the Card Defaults tab, configure the following fields:
      • Site:
        • Twitter/X handle (e.g., @yourtwitterhandle) for the site’s account.
      • Site ID:
        • Numeric Twitter/X ID for the site’s account (e.g., 123456789).
      • Creator:
        • Twitter/X handle for the content’s creator (e.g., @authorhandle).
      • Creator ID:
        • Numeric Twitter/X ID for the creator.
      • Description Option:
        • Meta (default): Uses the content’s meta description.
        • Text: Uses article intro/full text or contact miscellaneous text.
        • Limited to 280 characters.
      • Title Option:
        • Title (default, fixed): Uses the content’s title (e.g., article title, contact name).
        • Limited to 70 characters.
      • Image Option:
        • Intro: Uses the article’s intro image.
        • Full: Uses the article’s full-text image.
        • Any (default): Prefers full-text, then intro, then article body images.
        • For contacts, maps intro/full to any (uses contact’s image field).
      • Image Alt Option:
        • Title (default): Uses the content’s title.
        • Intro: Uses article intro text.
        • Full: Uses article full text.
        • Limited to 420 characters.
      • App Country:
        • 2-letter ISO 3166-1 alpha-2 code (e.g., US).
        • Default: US.
      • Player Width:
        • Default: 640 pixels.
        • Minimum: 1.
      • Player Height:
        • Default: 360 pixels.
        • Minimum: 1.
  • Notes:
    • Metadata fields are validated (e.g., image formats: jpg, jpeg, png, gif, webp).
    • The plugin prepends the site’s base URL to relative image/stream paths.

Fallback Image and Player Dimensions

  • Fallback Image:
    • Purpose: Provides a default image when no content-specific image is available.
    • Configuration:
      • In the Card Defaults tab, select an image using the Fallback Image media field (directory: images).
      • Supports jpg, jpeg, png, gif, and webp formats.
    • Notes:
      • The fallback image is used for all card types when no other image is specified.
  • Player Dimensions:
    • Purpose: Defines default dimensions for Player card media (video/audio).
    • Configuration:
      • Player Width: Numeric field, default 640 pixels.
      • Player Height: Numeric field, default 360 pixels.
    • Notes:
      • Used for player card types, including self-hosted streams.
      • Dimensions are cast to integers to ensure XSS protection in meta content.

Notes

  • Admin Interface: All settings are configured via Joomla’s plugin interface, with conditional fields for relevant options.
  • Overrides: Global defaults can be overridden per content item.
  • Performance: Enable caching (Section 8) to optimize metadata generation for these settings.
  • Troubleshooting: If cards or tweets do not render as expected, verify default settings.

Per-Content-Item Customization

The System - X Autopost plugin allows for detailed customization of tweet content and Twitter/X Card metadata on a per-content-item basis, overriding global defaults. This ensures tailored autoposting and link previews for specific articles or contacts. This section covers overrides for articles and contacts, configuration options, the admin interface, and conditional fields, accurate as of October 10, 2025.

Overriding Defaults for Articles (com_content) and Contacts (com_contact)

  • Purpose: Per-item overrides enable unique tweet text and card metadata for individual content items, superseding global settings while falling back to defaults if not specified.
  • Supported Components:
    • Articles (com_content): Full overrides available, including all card types (Summary, Summary Large Image, App, Player).
    • Contacts (com_contact): Limited overrides; card types restricted to Summary and Summary Large Image. App and Player types are disabled in the interface.

Configuring Custom Tweet Text and Card Metadata

  • Custom Tweet Text:
    • Field: custom_tweet (textarea, max 280 characters).
    • Behavior: If provided, uses this text for the autoposted tweet instead of constructed title/description. Supports placeholders or manual formatting.
    • Options:
      • For both articles and contacts: Enable/disable title (show_title) and description (show_description) inclusion.
      • Default: Inherits from global Tweet Defaults, but can be toggled per item (e.g., set to No for custom-only tweets).
  • Card Metadata:
    • Card Type (card_type):
      • Options: Default (uses global), Summary, Summary Large Image, App, Player (articles only).
      • For Player cards: Custom logic activates self-hosted streams if player is empty but player_stream is a local file.
    • Site and Creator Overrides:
      • site_option and site_id_option: Default or Custom.
      • If Custom: Enter site (handle), site_id (numeric ID), creator (handle), creator_id (numeric ID).
    • Description, Title, Image, and Alt Text:
      • description_option: Default, Meta, Text, or Custom (description field).
      • title_option: Default or Custom (title field).
      • image_option: Default, Intro, Full, Any, or Custom (image field, media path).
      • image_alt_option: Default, Title, Intro, Full, or Custom (image_alt field).
      • Character Limits: Description (280), Title (70), Image Alt (420) – trimmed via compressTrimText.
    • App-Specific Fields (App card type, articles only):
      • app_country (2-letter code, e.g., US).
      • iPhone/iPad/Google Play: Name, ID, URL (e.g., app_name_iphone, app_id_iphone).
    • Player-Specific Fields (Player card type, articles only):
      • player (embeddable URL, e.g., YouTube).
      • player_stream (stream URL or local file path).
      • player_width and player_height (integers, default to globals).
  • Submitted Status (submitted):
    • Yes/No: Marks if autoposting has occurred; set to Yes to prevent re-posting on updates. Alternatively, you can re-post a tweet by setting this field to No and saving the content or contact item.

Using Joomla Admin Interface for Per-Item Settings

  1. Accessing Settings - the X Autopost tab:
    • For Articles: Edit an article in Content > Articles > Select article.
    • For Contacts: Edit a contact in Components > Contacts > Select contact.
  2. Tweet Fieldset:
    • Configure show_title, show_description, and custom_tweet.
  3. Twitter Card Fieldset:
    • Set card type, overrides, and metadata fields.
  4. Saving Changes:
    • Click Save to store overrides.
    • On save, the plugin triggers autoposting if credentials are set and coverage matches.

Notes

  • Fallbacks: Unset fields use global defaults or content data (e.g., article images).
  • Validation: Handled in PHP (e.g., URL filters, image extensions).
  • Troubleshooting: If overrides don’t apply, clear cache.

Special Features and Output Types

The System - X Autopost plugin includes advanced features and output types to enhance Twitter/X Card generation and media presentation for Joomla content. This section details the supported Twitter/X Card types, the custom self-hosted player logic, media output templates, video/audio template overrides, and metadata validation processes, accurate as of October 10, 2025.

Twitter/X Card Types

The plugin supports four Twitter/X Card types, each designed for specific content presentation on X/Twitter. These are configured globally or per content item (see Sections 5 and 6) and defined in XMeta.php.

Summary

  • Description: Displays a concise preview with a title, description, and small thumbnail image.
  • Metadata Fields (from XMeta.php):
    • site, site_id: Twitter/X handle and ID for the site.
    • description: Short text (up to 280 characters).
    • title: Content title (up to 70 characters).
    • image: Thumbnail image URL.
    • image_alt: Image alt text (up to 420 characters).
  • Use Case: Ideal for general content sharing, such as blog posts or contact profiles.
  • Validation: Requires title, description, and image.

Summary Large Image

  • Description: Similar to Summary but prioritizes a larger, more prominent image for visual impact.
  • Metadata Fields:
    • All Summary fields plus creator, creator_id (author’s Twitter/X handle and ID).
  • Use Case: Best for visually rich content, like articles with high-quality images.
  • Validation: Requires title, description, image, and either site or creator.

App

  • Description: Promotes mobile apps with links to app stores (iPhone, iPad, Google Play).
  • Metadata Fields:
    • Summary fields plus:
      • app_country: 2-letter ISO 3166-1 code (e.g., US).
      • iPhone: app_name_iphone, app_id_iphone, app_url_iphone.
      • iPad: app_name_ipad, app_id_ipad, app_url_ipad.
      • Google Play: app_name_googleplay, app_id_googleplay, app_url_googleplay.
  • Use Case: Suitable for promoting Joomla-related mobile apps.
  • Validation: Requires app-specific fields for at least one platform.
  • Note: Disabled for contacts (com_contact).

Player

  • Description: Embeds playable media (video or audio) with an interactive player.
  • Metadata Fields:
    • Summary fields plus:
      • player: URL to an embeddable player (e.g., YouTube, Vimeo).
      • player_width, player_height: Player dimensions (default: 640x360).
      • stream: Optional stream URL or local file path for self-hosted media.
  • Use Case: Ideal for sharing multimedia content, such as videos or podcasts.
  • Validation: Requires player or stream for self-hosted media, plus valid dimensions.
  • Note: Disabled for contacts in twittercard.com_contact.xml.

Self-Hosted Player Logic

  • Description: A custom modification enables self-hosted media playback in Player cards when the player field is empty but the stream field contains a local file path.
  • Implementation (from XMeta_com_content.php and recent modification):
    • If player is empty and player_stream is a valid local file (checked via file_exists in JPATH_ROOT), the plugin generates a self-hosted player.
    • The stream URL is converted to an absolute URL by prepending the site’s base URL (getBaseUrl in XMeta.php).
    • The plugin uses video.php or audio.php templates to render the media.
  • Use Case: Enables hosting video or audio files directly on the Joomla server, avoiding reliance on third-party platforms like YouTube.
  • Configuration:
    • Set player_stream to a local file path (e.g., media/videos/sample.mp4).
    • Ensure player is empty to trigger self-hosted logic.
    • Configure player_width and player_height for proper display.
  • Notes:
    • File paths must be accessible within Joomla’s JPATH_ROOT directory.
    • player_stream can be used with externally hosted player URLs, in this scenario the stream becomes a backup if there is a problem with the player URL.

Media Output

The plugin includes templates for rendering media in Player cards, customizable for specific use cases.

Video Template (video.php)

  • Purpose: Generates an HTML page with a <video> element for Player card media.
  • Structure:
    • Contains a <video controls> tag with a <source> element using $url (media URL) and $mimetype (e.g., video/mp4).
    • Includes a fallback <p> tag with $translatedMessage for browsers that don’t support the video.
    • Uses minimal HTML with UTF-8 charset and responsive viewport.
  • Use Case: Displays self-hosted or external videos in Twitter/X Player cards.
  • Customization: Create a template output override, detailed below.

Audio Template (audio.php)

  • Purpose: Generates an HTML page with an <audio> element, styled with a background image.
  • Structure:
    • Contains an <audio controls> tag with a <source> element using $url and $mimetype (e.g., audio/mpeg).
    • Includes a fallback <p> tag with $translatedMessage.
    • CSS styles:
      • Background image from $background variable (URL or path).
      • Full-screen, centered layout with cover sizing and black background fallback.
  • Use Case: Plays audio files (e.g., podcasts) with a visually appealing background.
  • Customization: Create a template output override, detailed below.

Video/Audio Template Output Overrides

  • Purpose: Allows developers to customize the HTML/CSS output of video.php and audio.php for tailored media presentation.
  • Customization Options:
    • Modify PHP variables ($url, $mimetype, $background, $translatedMessage) to integrate dynamic data.
    • Adjust HTML structure (e.g., add controls, preload settings, or additional metadata).
    • Customize CSS in audio.php for background styling (e.g., change background-size or add animations).
    • Override templates by creating modified versions of plugins/system/xautopost/tmpl/audio.php (or video.php) in a Joomla template override directory (e.g., templates/your_template/html/plg_system_xautopost/).
  • Use Case: Tailor media players to match site branding or add advanced playback features.
  • Note: Ensure modified templates maintain compatibility with Twitter/X Card requirements (e.g., valid MIME types).

Metadata Validation

The plugin enforces strict validation to ensure Twitter/X Cards render correctly.

Image Format Validation

  • Supported Formats: jpg, jpeg, png, gif, webp.
  • Process:
    • For articles: Validates images from image_intro, image_fulltext, or article body (articleImage method).
    • For contacts: Validates image field or fallback image.
    • Invalid images fall back to the global fallback_image or return false.
  • Note: Only absolute URLs or valid local paths (converted to URLs) are accepted.

Character Limits

  • Description: 280 characters.
    • Trims text to remove newlines, extra spaces, and enforce length.
  • Title: 70 characters (getTitle methods).
    • Uses content title or custom input, trimmed as needed.
  • Image Alt Text: 420 characters (getImage_alt methods).
    • Sourced from title, intro/full text, or custom input, trimmed for compliance.
  • Implementation: Ensure compliance with tweet limitations to ensure card previews are displayed.

Caching and Performance

The System - X Autopost plugin includes caching functionality to optimize performance by reducing the overhead of generating Twitter/X Card metadata and querying the database. This section explains how to enable or disable caching, configure cache group and lifetime settings, and the impact of caching on metadata generation performance, accurate as of October 10, 2025.

Enabling/Disabling Caching

  • Purpose: Caching stores pre-generated Twitter/X Card metadata to minimize database queries and processing for frequently accessed content, improving page load times.
  • Configuration:
    • Navigate to System > Manage > Plugins > System - X Autopost in the Joomla admin panel.
    • In the plugin’s configuration, locate the Caching setting.
      • Enable: Select Yes to activate caching (default: enabled).
      • Disable: Select No to bypass caching, forcing real-time metadata generation for each request.
    • Save the configuration by clicking Save or Save & Close.
  • Implementation:
    • When enabled, metadata is stored in the cache group plg_system_xautopost and retrieved for subsequent requests.
  • Notes:
    • Disabling caching is useful for debugging or ensuring real-time metadata updates but may degrade performance on high-traffic sites.
    • Ensure Joomla’s global caching is enabled (System > Global Configuration > System > Cache Settings) for the plugin’s caching to function.

Cache Group and Lifetime Settings

  • Cache Group:
    • Default Group: plg_system_xautopost.
    • Purpose: Isolates the plugin’s cache entries from other Joomla cache groups, preventing conflicts.
  • Cache Lifetime:
    • Default Lifetime: Inherits Joomla’s global cache time setting (default: 15 minutes, configurable in System > Global Configuration > System > Cache Settings).
    • Configuration:
      • To adjust the lifetime, modify Joomla’s global cache time in the admin panel.
  • Notes:
    • Longer cache lifetimes reduce database queries but may delay updates to metadata (e.g., after editing an article).
    • Clear the cache manually (System > Clear Cache) after significant content changes if immediate updates are needed.

Troubleshooting

The System - X Autopost plugin integrates with Joomla and X/Twitter to generate Twitter/X Cards and automate content posting. This section addresses common issues, provides guidance on debugging autoposting failures, and explains how to verify Twitter/X Card rendering, accurate as of October 10, 2025.

Common Issues

Below are frequent issues users may encounter, along with their causes and solutions.

API Credential Errors

  • Symptoms:
    • Autoposting fails silently or logs errors in Joomla.
    • Tweets are not posted to X/Twitter despite content updates.
  • Causes:
    • Incorrect or missing Consumer Key, Consumer Secret, Access Token, or Access Token Secret in the plugin’s configuration.
    • Expired or revoked API credentials in the Twitter/X Developer Portal.
    • Insufficient app permissions (e.g., missing Read and Write access).
  • Solutions:
    • Verify Credentials: Navigate to System > Manage > Plugins > System - X Autopost > Credentials tab. Ensure all fields (Consumer Key, Consumer Secret, Access Token, Access Token Secret) match those in the Twitter/X Developer Portal (developers.x.com).
    • Regenerate Credentials: In the Developer Portal, go to your app’s Keys and Tokens tab and regenerate any missing or invalid credentials.
    • Check Permissions: Ensure the app has Read and Write permissions in the Developer Portal’s Edit App settings.

Caching Issues

  • Symptoms:
    • Outdated Twitter/X Card metadata is displayed on X/Twitter.
    • Changes to content or plugin settings (e.g., new images, descriptions) don’t reflect in previews.
  • Causes:
    • Cached metadata in the plg_system_xautopost cache group is not refreshed.
    • Joomla’s global cache settings have a long lifetime, delaying updates.
    • Cache not invalidated after content updates.
  • Solutions:
    • Clear Cache: Go to System > Clear Cache in the Joomla admin panel, select the plg_system_xautopost group, and clear it.
    • Adjust Cache Lifetime: In System > Global Configuration > System > Cache Settings, reduce the cache time (default: 15 minutes) for faster updates.
    • Disable Caching Temporarily: In the plugin’s configuration, set Caching to No to bypass caching during troubleshooting.

Other Common Issues

  • No Autoposting for Content:
    • Cause: Content may not match coverage settings (e.g., excluded categories or unsupported components).
    • Solution: Check Coverage settings to ensure the component (com_content, com_contact) and categories are included.
  • Invalid Images in Cards:
    • Cause: Images don’t meet Twitter/X requirements (jpg, jpeg, png, gif, webp) or are inaccessible.
    • Solution: Verify image paths in image or fallback_image fields and ensure they are publicly accessible (Section 7).
  • Player Card Not Rendering:
    • Cause: Invalid player or player_stream URLs, or self-hosted files not found in JPATH_ROOT.

Debugging Autoposting Failures

When autoposting fails you will see the error message provided by X displayed in the system message area.  Follow these steps to diagnose the issue:

  1. Check Plugin Status:
    • Ensure the plugin is enabled (System > Manage > Plugins > System - X Autopost).
    • Verify API credentials are entered correctly (see API Credential Errors above).
  2. Test Coverage Settings:
    • Confirm the content item falls within the configured components and categories (Coverage tab).
    • Test by temporarily setting Exclude Categories to No and selecting no categories to include all content.

Verifying Twitter/X Card Rendering

To ensure Twitter/X Cards display correctly on X/Twitter:

  1. Inspect Generated Metadata:
    • View the page source of the content item in a browser (e.g., yourwebsite.com/index.php/articles/sample-article).
    • Look for <meta> tags with name attributes like twitter:title, twitter:image, etc., generated by XMeta classes.
    • Ensure all required fields for the card type are present (e.g., image for Summary Large Image).
  2. Test Self-Hosted Media:
    • For Player cards, verify the player_stream URL resolves to a valid file in JPATH_ROOT (e.g., media/videos/sample.mp4).
    • Access the video/audio player URL presented in the twitter:player metadata tag.
  3. Check Cache Impact:
    • If metadata is incorrect, clear the cache (System > Clear Cache > plg_system_xautopost) to refresh data.
    • Disable caching temporarily to test real-time metadata generation.
  4. Validate URLs:
    • Ensure all URLs (image, player, player_stream) are absolute and accessible.
    • Test URLs in a browser to confirm they load without errors (e.g., no 404 or permission issues).

Notes

  • API Rate Limits: Twitter/X API limits may cause autoposting failures on high-volume sites. Check limits in the Developer Portal.

Why is this software free?

​
I’m ditching the freemium game and giving this software to the Joomla crowd for free. It’s a nod to “Jumla”—Swahili for “all together”—because fragmentation sucks, and I’d rather focus on innovation and paid gigs. Use it, build with it, and if you need custom work, I’m super into that.

What's The Catch?

​ ​
There isn’t one! I’m all about building tools that empower the Joomla community and spark creativity. This software’s free because I’d rather see it in your hands - fueling awesome projects. If you really feel like paying something, I’d appreciate a review in the Joomla Extension Directory—your feedback means a lot!
Copyright © 2025 RicheyWeb. All Rights Reserved.