Developer Documentation

Warning: This version of Altis is no longer supported

Facebook Instant Articles

Facebook Instant Articles enables publishers to monetise and make content available natively within Facebook's website and apps using a custom feed.

This component is powered by the official Facebook Instant Articles plugin.

Pre-requisites

  • A Facebook page for your organisation
  • A Facebook App

Configuration

Configuration is managed via the CMS admin under the Instant Articles menu item. Follow the wizard to complete the setup before moving onto customising how your content will be transformed and displayed.

Content Transformation

The plugin will parse and transform your content automatically by following the default configuration rules JSON. You can find the documentation for the transformer rules in Facebook's documentation here.

You can provide your own custom file using the instant_articles_transformer_rules_configuration_json_file_path filter:

add_filter( 'instant_articles_transformer_rules_configuration_json_file_path', function ( string $path ) : string {
	return __DIR__ . '/custom-rules.json';
} );

The Transform object that interprets those rules provided by the Facebook SDK can be accessed and modified using the instant_articles_transformer_rules_loaded filter.

use Facebook\InstantArticles\Transformer\Transformer;
add_filter( 'instant_articles_transformer_rules_loaded', function ( Transformer $transformer ) : Transformer {
	// Add more custom rules.
	$transformer->loadRules( __DIR__ . '/custom-rules.json' );

	return $transformer;
} );

See the documentation for the Transformer class and creating custom rule classes and the Instant Articles PHP SDK github repository for more information.