Documentation

WooCommerce Plugin Developer Handbook

Want to create a plugin to extend WooCommerce? WooCommerce plugins are the same as regular WordPress plugins. For more information, visit Writing a plugin.

Your WooCommerce extension should:

Adhere to all WordPress plugin coding standards and best practice guidelines for harmonious existence within WordPress and alongside other WordPress plugins.
Have a single core purpose and use WooCommerce features as much as possible.
Not do anything malicious or underhanded — for example, inserting spam links or upselling services outside of the WooCommerce.com ecosystem.
Not subvert or override Marketplace connections in core — for example, extensions cannot create branded top-level menu items or introduce their own telemetry.
Adhere to Marketplace compatibility and interoperability guidelines.

Merchants make use of WooCommerce extensions daily, and should have a unified and pleasant experience while doing so without advertising invading their WP Admin or store.

Note: We provide this page as a best practice for developers.

Note: We are unable to provide support for custom code under our Support Policy. If you are unfamiliar with code and resolving potential conflicts, select a WooExpert or Developer for assistance.

	$label = __( 'Enable Logging', 'your-textdomain-here' );
	$description = __( 'Enable the logging of errors.', 'your-textdomain-here' );

	if ( defined( 'WC_LOG_DIR' ) ) {
	$log_url = add_query_arg( 'tab', 'logs', add_query_arg( 'page', 'wc-status', admin_url( 'admin.php' ) ) );
	$log_key = 'your-plugin-slug-here-' . sanitize_file_name( wp_hash( 'your-plugin-slug-here' ) ) . '-log';
	$log_url = add_query_arg( 'log_file', $log_key, $log_url );

	$label .= ' \| ' . sprintf( __( '%1$sView Log%2$s', 'your-textdomain-here' ), '<a href="' . esc_url( $log_url ) . '">', '</a>' );
	}

	$form_fields['wc_yourpluginslug_debug'] = array(
	'title' => __( 'Debug Log', 'your-textdomain-here' ),
	'label' => $label,
	'description' => $description,
	'type' => 'checkbox',
	'default' => 'no'
	);

	<?xml version="1.0"?>
	<ruleset name="WordPress Coding Standards">
	<description>WooCommerce extension PHP_CodeSniffer ruleset.</description>

	<!– Exclude paths –>
	<exclude-pattern>tests/</exclude-pattern>
	<exclude-pattern>woo-includes/woo-functions.php</exclude-pattern>
	<exclude-pattern>woo-includes/class-wc-dependencies.php</exclude-pattern>
	<exclude-pattern>/node_modules/</exclude-pattern>
	<exclude-pattern>/vendor/</exclude-pattern>

	<!– Configs –>
	<config name="minimum_supported_wp_version" value="4.7" />
	<config name="testVersion" value="7.2-" />

	<!– Rules –>
	<rule ref="WordPress-Core">
	<!– WPCS 3.0 added these, but we're not yet ready to force them upon third-party vendors: –>
	<exclude name="Generic.WhiteSpace.IncrementDecrementSpacing" />
	<exclude name="Modernize.FunctionCalls.Dirname" />
	<exclude name="PEAR.Files.IncludingFile" />
	<exclude name="PSR12.Traits.UseDeclaration" />
	<exclude name="PSR2.Classes.ClassDeclaration.CloseBraceAfterBody" />
	<exclude name="PSR2.Files.EndFileNewline.TooMany" />
	<exclude name="PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose" />
	<exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing" />
	<exclude name="Universal.Constants.UppercaseMagicConstants" />
	<exclude name="Universal.Namespaces" />
	<exclude name="Universal.UseStatements.NoLeadingBackslash" />
	</rule>

	<rule ref="WordPress-Extra">
	<exclude name="Generic.Commenting.DocComment.SpacingAfter" />
	<exclude name="Generic.Files.LineEndings.InvalidEOLChar" />
	<exclude name="Generic.Functions.FunctionCallArgumentSpacing.SpaceBeforeComma" />
	<exclude name="PEAR.Functions.FunctionCallSignature" />
	<exclude name="Squiz.Commenting" />
	<exclude name="Squiz.PHP.DisallowSizeFunctionsInLoops.Found" />
	<exclude name="Squiz.WhiteSpace" />
	<exclude name="WordPress.Arrays" />
	<exclude name="WordPress.Files.FileName" />
	<exclude name="WordPress.NamingConventions" />
	<exclude name="WordPress.Security.EscapeOutput.ErrorNotEscaped" />
	<exclude name="WordPress.Security.EscapeOutput.ExceptionNotEscaped" />
	<exclude name="WordPress.Security.ValidatedSanitizedInput.MissingUnslash" />
	<exclude name="WordPress.WhiteSpace" />
	<exclude name="WordPress.WP.I18n.NonSingularStringLiteralText" />

	<!– WPCS 3.0 added these, but we're not yet ready to force them upon third-party vendors: –>
	<exclude name="Universal.CodeAnalysis.NoEchoSprintf" />
	<exclude name="Universal.ControlStructures.DisallowLonelyIf" />
	<exclude name="Universal.Files.SeparateFunctionsFromOO" />
	<exclude name="WordPress.WP.I18n.EmptyTextDomain" />

	<!– WPCS 3.0 added these, replacing WordPress.Arrays.* items which we previously excluded: –>
	<exclude name="NormalizedArrays.Arrays.ArrayBraceSpacing" />
	<exclude name="NormalizedArrays.Arrays.CommaAfterLast" />

	<!– WPCS 3.0 moved some WordPress.WhiteSpace/Squiz.WhiteSpace sniffs into these: –>
	<exclude name="Generic.WhiteSpace.LanguageConstructSpacing" />
	<exclude name="Squiz.Functions.MultiLineFunctionDeclaration" />
	<exclude name="Universal.WhiteSpace" />
	</rule>

	<rule ref="WooCommerce-Core">
	<exclude name="Core.Commenting.CommentTags.AuthorTag" />
	<exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect" />
	<exclude name="Universal.Arrays.DisallowShortArraySyntax" />
	<exclude name="WooCommerce.Commenting.CommentHooks.HookCommentWrongStyle" />
	<exclude name="WooCommerce.Commenting.CommentHooks.MissingHookComment" />
	<exclude name="WooCommerce.Commenting.CommentHooks.MissingSinceComment" />
	<exclude name="WordPress.PHP.DontExtract" />
	</rule>

	<rule ref="PHPCompatibility">
	<exclude-pattern>tests/</exclude-pattern>
	</rule>
	</ruleset>