vendor\/bin\/phpunit<\/code>.<\/p>\n\nHooks<\/h3>\n\n
The Substack Importer provides filters and actions at key stages of the content conversion pipeline.<\/p>\n\n
Post-level Filters<\/h4>\n\nsubstack_importer_post_meta<\/h3>\n\n
Filter the post metadata loaded from the Substack API before it is used for author, comments, and other post data.<\/p>\n\n
Parameters:\n* $post_meta<\/code> (array|null) - The post metadata from the Substack API response.\n* $post<\/code> (array) - The raw Substack post data from the CSV.\n* $id<\/code> (int) - The Substack post ID.<\/p>\n\nsubstack_importer_raw_content<\/h3>\n\n
Filter the raw HTML content before Gutenberg conversion. Runs after the subtitle has been prepended (if present). Useful for cleaning up Substack-specific HTML, adding custom elements, or stripping unwanted markup.<\/p>\n\n
Parameters:\n* $html_body<\/code> (string) - The raw HTML content from the Substack export.\n* $post<\/code> (array) - The raw Substack post data from the CSV.\n* $post_meta<\/code> (array|null) - The post metadata from the Substack API response.<\/p>\n\nsubstack_importer_subtitle<\/h3>\n\n
Filter the subtitle HTML before it is prepended to the post content. Return an empty string to skip the subtitle entirely.<\/p>\n\n
Parameters:\n* $heading<\/code> (string) - The subtitle HTML (default: an h2 element).\n* $post<\/code> (array) - The raw Substack post data.<\/p>\n\nsubstack_importer_post_content_after_conversion<\/h3>\n\n
Filter the post content after Gutenberg conversion but before it is added to the WXR. Useful for wrapping paywalled content in custom blocks (e.g., membership plugins).<\/p>\n\n
Parameters:\n* $post_content<\/code> (string) - The converted Gutenberg block content.\n* $post<\/code> (array) - The original Substack post data.\n* $post_meta<\/code> (array|null) - Additional post metadata from Substack API.<\/p>\n\nsubstack_importer_post_data<\/h3>\n\n
Filter the final post data array before it is added to the WXR.<\/p>\n\n
Parameters:\n* $post_data<\/code> (array) - The post data.\n* $post<\/code> (array) - The original Substack post data.<\/p>\n\nContent Conversion Filters<\/h4>\n\nsubstack_importer_converted_node<\/h3>\n\n
Filter the result of a single node conversion to a Gutenberg block. Allows modification of the block name and attributes. Return a null block_name to skip the node.<\/p>\n\n
Parameters:\n* $block_data<\/code> (array) - Array with 'block_name' and 'block_attributes' keys.\n* $node<\/code> (DOMElement) - The converted DOM node.\n* $node_name<\/code> (string) - The original HTML tag name (e.g. 'p', 'div', 'h2').<\/p>\n\nsubstack_importer_image_result<\/h3>\n\n
Filter the image node conversion result. Useful for adjusting image sizes, captions, or link destinations.<\/p>\n\n
Parameters:\n* $result<\/code> (array) - Array with 'block_attributes' and 'node' keys.\n* $image_data<\/code> (array|null) - The decoded image data from the Substack data-attrs attribute.<\/p>\n\nsubstack_importer_pre_embed_conversion<\/h3>\n\n
Short-circuit the embed node conversion before default handling. Return a non-null array to skip the built-in switch statement entirely. Useful for handling unsupported embed types or overriding the default conversion for a specific provider.<\/p>\n\n
Parameters:\n* $pre_result<\/code> (array|null) - Return non-null to short-circuit. Expected keys: 'node', 'block_attributes', 'block_name'.\n* $node<\/code> (DOMElement) - The embed DOM node before conversion.\n* $parent<\/code> (DOMElement) - The parent DOM element.\n* $first_class<\/code> (string) - The CSS class identifying the embed type (e.g. 'youtube-wrap', 'tweet').<\/p>\n\nsubstack_importer_embed_result<\/h3>\n\n
Filter the embed node conversion result after the default conversion. Useful for modifying embed URLs, adding custom attributes, or changing how embeds are represented.<\/p>\n\n
Parameters:\n* $output<\/code> (array) - Array with 'block_name', 'block_attributes', and 'node' keys.\n* $first_class<\/code> (string) - The CSS class identifying the embed type.<\/p>\n\nsubstack_importer_audio_block<\/h3>\n\n
Filter the Gutenberg audio block HTML for podcast posts.<\/p>\n\n
Parameters:\n* $block<\/code> (string) - The Gutenberg audio block HTML.\n* $audio_url<\/code> (string) - The URL of the podcast audio file.<\/p>\n\nPaywall Filters<\/h4>\n\nsubstack_importer_paywall_marker_text<\/h3>\n\n
Filter the paywall marker text that appears in the imported content.<\/p>\n\n
Parameters:\n* $marker_text<\/code> (string) - The default paywall marker text.\n* $node<\/code> (DOMElement) - The paywall node being converted.\n* $parent<\/code> (DOMElement) - The parent element.<\/p>\n\nsubstack_importer_paywall_content<\/h3>\n\n
Filter the entire paywall conversion result. Return a non-null value to override the default conversion.<\/p>\n\n
Parameters:\n* $result<\/code> (array|null) - The conversion result, null to use default.\n* $node<\/code> (DOMElement) - The paywall node being converted.\n* $parent<\/code> (DOMElement) - The parent element.<\/p>\n\nActions<\/h4>\n\nsubstack_importer_before_post<\/h3>\n\n
Fires before a single Substack post is processed and converted. Useful for setting up state or performing actions before conversion begins.<\/p>\n\n
Parameters:\n* $post<\/code> (array) - The raw Substack post data from the CSV.\n* $post_meta<\/code> (array|null) - The post metadata from the Substack API response.\n* $id<\/code> (int) - The Substack post ID.<\/p>\n\nsubstack_importer_after_post<\/h3>\n\n
Fires after a single Substack post has been converted and added to the WXR. Useful for logging, progress tracking, or performing cleanup after each post.<\/p>\n\n
Parameters:\n* $post_data<\/code> (array) - The final post data that was added to the WXR.\n* $post<\/code> (array) - The raw Substack post data from the CSV.\n* $post_meta<\/code> (array|null) - The post metadata from the Substack API response.\n* $id<\/code> (int) - The Substack post ID.<\/p>\n\n\nThis plugin depends on the WordPress Importer<\/a> plugin which needs to be installed first.<\/p>\n\nTo install the Substack Importer:<\/p>\n\n
\n- Upload the
substack-importer<\/code> directory to the \/wp-content\/plugins\/<\/code> directory<\/li>\n- Activate the plugin through the 'Plugins' menu in WordPress<\/li>\n<\/ol>\n\n\n
\nAfter about 30 seconds, the import stops and I am seeing a blank screen. What happened?<\/h3><\/dt>\nWhen trying to import a large number of posts and images, timeouts can occur. To solve this, you can try to run the import\nseveral times until all content has been imported.<\/p><\/dd>\n\n<\/dl>\n\n\n
1.2.0<\/h4>\n\n\n- Compatibility: the plugin now requires PHP 7.4 or higher.<\/li>\n
- Enhancement: added new pre-import options for forcing Draft status, choosing publish date mode, setting the first image as Featured Image, and applying a global Category\/Tag.<\/li>\n
- Enhancement: improved import behavior handling for featured image assignment and post metadata processing during import.<\/li>\n
- Enhancement: added
substack_importer_paywall_marker_text<\/code> filter to customize paywall marker text.<\/li>\n- Enhancement: added
substack_importer_paywall_content<\/code> filter to override paywall block conversion.<\/li>\n- Enhancement: added
substack_importer_post_content_after_conversion<\/code> filter to modify content after Gutenberg conversion.<\/li>\n- Enhancement: added
substack_importer_raw_content<\/code> filter to modify raw HTML before Gutenberg conversion.<\/li>\n- Enhancement: added
substack_importer_subtitle<\/code> filter to customize or skip the subtitle heading.<\/li>\n- Enhancement: added
substack_importer_post_meta<\/code> filter to modify post metadata before processing.<\/li>\n- Enhancement: added
substack_importer_converted_node<\/code> filter to customize individual block conversions.<\/li>\n- Enhancement: added
substack_importer_image_result<\/code> filter to modify image block attributes.<\/li>\n- Enhancement: added
substack_importer_embed_result<\/code> filter to modify embed block results after conversion.<\/li>\n- Enhancement: added
substack_importer_pre_embed_conversion<\/code> filter to short-circuit embed conversion before default handling.<\/li>\n- Enhancement: added
substack_importer_audio_block<\/code> filter to customize the podcast audio block.<\/li>\n- Enhancement: added
substack_importer_before_post<\/code> action that fires before each post is processed.<\/li>\n- Enhancement: added
substack_importer_after_post<\/code> action that fires after each post is added to the WXR.<\/li>\n<\/ul>\n\n1.1.2<\/h4>\n\n\n- Enhancement: support captions for images.<\/li>\n
- Enhancement: support TikTok embeds<\/li>\n
- Compatibility: the plugin now requires PHP 7.2 or higher.<\/li>\n
- Fix: convert preformatted content to verse block.<\/li>\n
- Fix: twitter conversion bug.<\/li>\n<\/ul>\n\n
1.1.1<\/h4>\n\n\n- Tested up to WordPress 6.7<\/li>\n
- Fix: null checking<\/li>\n<\/ul>\n\n
1.1.0<\/h4>\n\n\n- Update
wxr-generator<\/code> to latest version. Fixes a bug where imports could error out due to a misformed timezone identifier.<\/li>\n<\/ul>\n\n1.0.9<\/h4>\n\n\n- Use subtitle as post excerpt if not empty<\/li>\n
- Testing the plugin up to WordPress 6.4.2<\/li>\n
- Fix PHPCS error and cleanup composer.lock<\/li>\n<\/ul>\n\n
1.0.8<\/h4>\n\n\n- Removed the subscription input from post content<\/li>\n<\/ul>\n\n
1.0.7<\/h4>\n\n\n- Convert the paywall div to a paragraph<\/li>\n<\/ul>\n\n
1.0.6<\/h4>\n\n\n- Testing the plugin up to WordPress 6.2<\/li>\n<\/ul>\n\n
1.0.5<\/h4>\n\n\n- Add support for WordPress 6.1<\/li>\n<\/ul>\n\n
1.0.4<\/h4>\n\n\n- Fix Soundcloud embeds<\/li>\n<\/ul>\n\n
1.0.3<\/h4>\n\n\n- Identify authors for draft posts as \"Draft Posts\"<\/li>\n<\/ul>\n\n
1.0.2<\/h4>\n\n\n- Republishing to fix a CI error.<\/li>\n<\/ul>\n\n
1.0.1<\/h4>\n\n\n- Remove unnecessary load_meta_data line.<\/li>\n
- Fix embeds not displaying properly on website.<\/li>\n<\/ul>\n\n
1.0.0<\/h4>\n\n\n- Add post meta for paid content.<\/li>\n
- Convert Instagram embed to a link.<\/li>\n
- Add the subtitle as a H2 at the beginning of the post.<\/li>\n
- Set the correct comment_status for posts.<\/li>\n<\/ul>\n\n
0.1.0<\/h4>\n\n\n- Refactored the importer.<\/li>\n
- Add support for authors.<\/li>\n
- Add support for comments.<\/li>\n
- Conversion of content to Gutenberg blocks.<\/li>\n
- Convert the export to WXR and use the WordPress Importer plugin to import the WXR.<\/li>\n
- Add progress indicator<\/li>\n
- Add support for attachments.<\/li>\n<\/ul>\n\n
0.1<\/h4>\n\n
Early proof-of-concept version.<\/p>","raw_excerpt":"The Substack Importer allows you to import content from a Substack newsletter into your WordPress site.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/133443","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"author":[{"embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/users\/5911429"}],"replies":[{"embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=133443"}],"wp:attachment":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=133443"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=133443"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=133443"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=133443"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=133443"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=133443"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}