Functions and methods

The PHP functions, classes and JavaScript objects that are safe to call from your own code. This is a much smaller surface than the hook reference — the plugin is customised mainly through hooks, and these are what you use inside those callbacks.

Anything not listed here is internal. It may exist, it may look useful, and it may change without notice.

PHP functions

All of these are available once the plugin has loaded. Hook onto mkl_pc_is_loaded, or anything later than plugins_loaded, before calling them.

mkl_pc()

The service locator. Called with no argument it returns the plugin instance; with a component name it returns that component.

$theme       = mkl_pc( 'settings' )->get_theme();$show_prices = mkl_pc( 'settings' )->get( 'show_price_in_configurator' );

An unknown name returns false rather than throwing, so guard when you are not sure:

$admin = mkl_pc( 'admin' );if ( $admin ) {	// only exists on admin requests}

mkl_pc_is_configurable() and mkl_pc_get_configurator_type()

The two guards most third-party code needs. Both fall back to the current post when called with no argument, so inside the loop you can omit it.

add_action( 'woocommerce_after_add_to_cart_form', function () {	if ( ! mkl_pc_is_configurable() ) {		return;	}	if ( '3d' === mkl_pc_get_configurator_type() ) {		echo '<p>' . esc_html__( 'Drag to rotate the model.', 'my-plugin' ) . '</p>';	}} );

mkl_pc_get_configurator_type() returns 'configurator' for a 2D configurator, '3d' for a 3D one, and false when the id is not a product at all. It resolves global configurators too, so a product that inherits its configurator still reports the right type.

mkl_pc_get_configuration_meta_mode()

Returns 'single' or 'individual', which determines which order hooks fire. Check it before assuming your filter runs.

Settings

mkl_pc( 'settings' ) is the one component you will use regularly.

$label = mkl_pc( 'settings' )->get_label(	'mkl_pc__button_label',	__( 'Configure', 'my-plugin' ));

Use get_label() rather than get() for anything shown to a customer — it runs the value through the translation layer, so WPML and Polylang work.

The third argument to get() matters more than it looks: by default an empty stored value is returned as-is, so a setting a merchant has cleared comes back as '' rather than your default. Pass true to fall back to the default in that case.

set() writes to the options table. It is intended for migrations and admin tooling, not for per-request use.

MKL\PC\Choice

The object representing one selected choice in a configuration. Cart and order hooks hand you these — see mkl_pc_item_meta.

add_filter( 'mkl_pc_item_meta', function ( $meta, $layer, $product, $item_key, $context ) {	if ( ! $layer->is_choice() ) {		return $meta;	}	$sku = $layer->get_choice( 'sku' );	if ( $sku ) {		$meta['value'] .= ' <code>' . esc_html( $sku ) . '</code>';	}	return $meta;}, 10, 5 );

The variable is conventionally named $layer in core even though it is a Choice — it carries both the layer and the selected choice, which is why it has two families of getter.

Always call is_choice() first. A Choice can represent a group or a layer with nothing selected, and the getters return empty values in that case rather than failing.

Choices are serialised into cart and order data. A property you add is lost unless you also add it to mkl_pc_choice_sleep_properties.

MKL\PC\Configuration

A saved configuration — the object behind saved designs, presets and order configurations.

$configuration = new \MKL\PC\Configuration( $configuration_id );$prices = $configuration->get_configured_price( array( 'quantity' => 2 ) );if ( ! is_wp_error( $prices ) ) {	echo wc_price( $prices['total'] );}foreach ( $configuration->get_layers() as $layer ) {	echo esc_html( $layer->get_layer( 'name' ) . ': ' . $layer->get_choice( 'name' ) );}

get_configured_price() returns a WP_Error when the product cannot be resolved — check for it. Its extra figure is only meaningful when the Extra Price add-on is active.

Constructing one with an id loads it; constructing with null and an args array builds a new one from raw content, which is how the plugin renders previews for order items.

MKL\PC\Utils

Static helpers. Most are internal, but a few are genuinely reusable:

kses_basic_inline_html() is the one to remember. Cart and order display run every label and value through it, so matching it in your own filters keeps output consistent:

add_filter( 'mkl_pc_cart_item_choice', function ( $html, $key, $value ) {	return \MKL\PC\Utils::kses_basic_inline_html( $html );}, 20, 3 );

Frontend JavaScript

PC.fe is the running configurator. It only exists once the configurator has been opened — do your work from PC.fe.start rather than on page load.

wp.hooks.addAction( 'PC.fe.start', 'my-plugin/configurator', function () {	PC.fe.layers.each( function ( layer ) {		const choices = PC.fe.getLayerContent( layer.id );		const active  = choices ? choices.findWhere( { active: true } ) : null;		console.log( layer.get( 'name' ), '→', active ? active.get( 'name' ) : '(none)' );	} );} );

getLayerContent() returns false for a layer with no choices — a group or a summary layer — so check before using it.

PC.fe.is_setting_config is how you distinguish a customer's click from a restored selection inside a PC.fe.choice.set_choice handler:

wp.hooks.addAction( 'PC.fe.choice.set_choice', 'my-plugin/configurator', function ( model ) {	if ( PC.fe.is_setting_config ) return; // restoring, not a real click	myAnalytics.track( 'choice', { name: model.get( 'name' ) } );} );

Use getSaveDataAsync() rather than save() if anything on the site registers PC.fe.save_data.before_save.promises — Text Overlay and the 3D viewer both do, and save() will not wait for them.

PC.utils

document.querySelector( '#my-total' ).textContent = PC.utils.formatMoney( 1234.5 );

formatMoney() honours the decimal and thousand separators, the symbol position and the precision configured in WooCommerce, so use it rather than toFixed().

3D

The 3D viewer exposes a live runtime API rather than a static object — scene, camera, renderer, material registry, events. See The 3D runtime API.

Constants

Use MKL_PC_PREFIX when reading the plugin's own meta directly rather than hard-coding the prefix — it has changed once already.