WP_Internal_Pointers::print_js( string $pointer_id, string $selector, array $args )

In this article

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Prints the pointer JavaScript data.

Parameters

$pointer_idstringrequired
The pointer ID.
$selectorstringrequired
The HTML elements, on which the pointer should be attached.
$argsarrayrequired
Arguments to be passed to the pointer JS (see wp-pointer.js).

Source

private static function print_js( $pointer_id, $selector, $args ) {
	if ( empty( $pointer_id ) || empty( $selector ) || empty( $args ) || empty( $args['content'] ) ) {
		return;
	}

	?>
	<script type="text/javascript">
	(function($){
		var options = <?php echo wp_json_encode( $args ); ?>, setup;

		if ( ! options )
			return;

		options = $.extend( options, {
			close: function() {
				$.post( ajaxurl, {
					pointer: '<?php echo $pointer_id; ?>',
					action: 'dismiss-wp-pointer'
				});
			}
		});

		setup = function() {
			$('<?php echo $selector; ?>').first().pointer( options ).pointer('open');
		};

		if ( options.position && options.position.defer_loading )
			$(window).bind( 'load.wp-pointers', setup );
		else
			$( function() {
				setup();
			} );

	})( jQuery );
	</script>
	<?php
}

Changelog

VersionDescription
3.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.