Pre-defined ad placements: make them filterable about newspack-ads

[miguelpeixe]

Ads placements have changed a lot since the writing of this issue. You can register new placements by using the Newspack_Ads::register_placement() method.

Example of a custom placement:

/**
 * Register "My Custom Placement" ad placement.
 */
function my_register_placement() {
	if( ! method_exists( '\Newspack_Ads', 'register_placement' ) ) {
		return false;
	}
	$placement_key    = 'my_custom_placement';
	$placement_config = array(
		'name'        => __( 'My Custom Placement', 'my-textdomain' ),
		'description' => __( 'Choose an ad unit to display in this custom placement', 'my-textdomain' ),
		'hook_name'   => 'my_custom_placement',
	);
	\Newspack_Ads::register_placement( $placement_key, $placement_config );
}
add_action( 'init', 'my_register_placement' );

To determine where the ad should be rendered, add the action hook on your theme where you'd like it to be displayed:

<?php do_action( 'my_custom_placement' ); ?>

You can see a full list of available config options:

newspack-ads/includes/class-placements.php

Lines 331 to 348 in c2aaf62

	/**
	* Get the available placements.
	*
	* A placement is an array with the following keys:
	* - name: The name of the placement.
	* - description: A description of the placement.
	* - show_ui: Whether this placement can be edited through the wizard. Default is true.
	* - default_enabled: Whether this placement should be enabled by default.
	* - default_ad_unit: A default ad unit name to be used for this placement.
	* - hook_name: The name of the WordPress action hook to inject an ad unit into.
	* - hooks: An array of action hooks to inject an ad unit into.
	* - name: The friendly name of the hook.
	* - hook_name: The name of the WordPress action hook to inject the ad unit into.
	* - supports: An array of supported placement features. Available features are:
	* - `stick_to_top`: Whether the placement should be sticky to the top of the page.
	*
	* @return array Placement objects.
	*/

[adekbadek]

Updated code location

[dero]

Looks great, thank you for the overview, @miguelpeixe – from my PoV this can be closed.

[miguelpeixe]

Thank you @dero!