Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

appease the linter

This commit is contained in:
Leif Singer 2023-11-06 13:15:39 +01:00
parent ecb746e8f1
commit 47accc8c4f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/extension-development/extension-developer-handbook.md
View File

@ -17,7 +17,7 @@ Note: We provide this page as a best practice for developers.
Most WooCommerce plugins do not need to run unless WooCommerce is already active. You can wrap your plugin in a check to see if WooCommerce is installed: Most WooCommerce plugins do not need to run unless WooCommerce is already active. You can wrap your plugin in a check to see if WooCommerce is installed:
``` ```php
// Test to see if WooCommerce is active (including network activated). // Test to see if WooCommerce is active (including network activated).
$plugin_path = trailingslashit( WP_PLUGIN_DIR ) . 'woocommerce/woocommerce.php'; $plugin_path = trailingslashit( WP_PLUGIN_DIR ) . 'woocommerce/woocommerce.php';
@ -77,7 +77,7 @@ Logs should be written to a file using the [WC_Logger](https://woocommerce.com/w
Try to prevent direct access data leaks. Add this line of code after the opening PHP tag in each PHP file: Try to prevent direct access data leaks. Add this line of code after the opening PHP tag in each PHP file:
``` ```php
if ( ! defined( 'ABSPATH' ) ) { if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly exit; // Exit if accessed directly
} }
@ -89,7 +89,7 @@ All plugins need a [standard WordPress readme](http://wordpress.org/plugins/abou
Your readme might look something like this: Your readme might look something like this:
``` ```php
=== Plugin Name === === Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's) Contributors: (this should be a list of wordpress.org userid's)
Tags: comments, spam Tags: comments, spam
@ -106,11 +106,11 @@ URI: http://www.gnu.org/licenses/gpl-3.0.html
To ensure a consistent experience for all WooCommerce users,including finding information on who to contact with queries, the following plugin headers should be in place: To ensure a consistent experience for all WooCommerce users,including finding information on who to contact with queries, the following plugin headers should be in place:
- The Plugin Author isYourName/YourCompany - The Plugin Author isYourName/YourCompany
- The Developer header is YourName/YourCompany, with the Developer URI field listed as http://yourdomain.com/ - The Developer header is YourName/YourCompany, with the Developer URI field listed as `http://yourdomain.com/`
For example: For example:
``` ```php
/** /**
* Plugin Name: WooCommerce Extension * Plugin Name: WooCommerce Extension
* Plugin URI: http://woocommerce.com/products/woocommerce-extension/ * Plugin URI: http://woocommerce.com/products/woocommerce-extension/
@ -198,7 +198,7 @@ You may want to log data that can be useful for debugging purposes. This is grea
If adding logging to your extension, here’s a snippet for presenting a link to the logs, in a way the extension user can easily make use of. If adding logging to your extension, here’s a snippet for presenting a link to the logs, in a way the extension user can easily make use of.
``` ```php
$label = \_\_( 'Enable Logging', 'your-textdomain-here' ); $label = \_\_( 'Enable Logging', 'your-textdomain-here' );
$description = \_\_( 'Enable the logging of errors.', 'your-textdomain-here' ); $description = \_\_( 'Enable the logging of errors.', 'your-textdomain-here' );
@ -228,4 +228,4 @@ $form_fields\['wc_yourpluginslug_debug'\] = array(
'default' => 'no' 'default' => 'no'
); );
``` ```