Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Commit

Permalink
Fix formatting (#7105)
Browse files Browse the repository at this point in the history 
Co-authored-by: Niels Lange <info@nielslange.de>
  • Loading branch information
@albarin @nielslange
albarin and nielslange authored Sep 9, 2022
1 parent 6cb49bc commit 0fecf2b
Showing 1 changed file with 55 additions and 62 deletions.
117 changes: 55 additions & 62 deletions woocommerce-gutenberg-products-block.php
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?php

/**
* Plugin Name: WooCommerce Blocks
* Plugin URI: https://github.com/woocommerce/woocommerce-gutenberg-products-block
Expand All @@ -17,53 +16,51 @@
* @internal This file is only used when running as a feature plugin.
*/

defined('ABSPATH') || exit;
defined( 'ABSPATH' ) || exit;

$minimum_wp_version = '6.0';

if (!defined('WC_BLOCKS_IS_FEATURE_PLUGIN')) {
define('WC_BLOCKS_IS_FEATURE_PLUGIN', true);
if ( ! defined( 'WC_BLOCKS_IS_FEATURE_PLUGIN' ) ) {
define( 'WC_BLOCKS_IS_FEATURE_PLUGIN', true );
}
/**
* Whether notices must be displayed in the current page (plugins and WooCommerce pages).
*
* @since 2.5.0
*/
function should_display_compatibility_notices()
{
function should_display_compatibility_notices() {
$current_screen = get_current_screen();

if (!isset($current_screen)) {
if ( ! isset( $current_screen ) ) {
return false;
}

$is_plugins_page =
property_exists($current_screen, 'id') &&
property_exists( $current_screen, 'id' ) &&
'plugins' === $current_screen->id;
$is_woocommerce_page =
property_exists($current_screen, 'parent_base') &&
property_exists( $current_screen, 'parent_base' ) &&
'woocommerce' === $current_screen->parent_base;

return $is_plugins_page || $is_woocommerce_page;
}

if (version_compare($GLOBALS['wp_version'], $minimum_wp_version, '<')) {
if ( version_compare( $GLOBALS['wp_version'], $minimum_wp_version, '<' ) ) {
/**
* Outputs for an admin notice about running WooCommerce Blocks on outdated WordPress.
*
* @since 2.5.0
*/
function woocommerce_blocks_admin_unsupported_wp_notice()
{
if (should_display_compatibility_notices()) {
?>
function woocommerce_blocks_admin_unsupported_wp_notice() {
if ( should_display_compatibility_notices() ) {
?>
<div class="notice notice-error">
<p><?php esc_html_e('The WooCommerce Blocks feature plugin requires a more recent version of WordPress and has been paused. Please update WordPress to continue enjoying WooCommerce Blocks.', 'woo-gutenberg-products-block'); ?></p>
<p><?php esc_html_e( 'The WooCommerce Blocks feature plugin requires a more recent version of WordPress and has been paused. Please update WordPress to continue enjoying WooCommerce Blocks.', 'woo-gutenberg-products-block' ); ?></p>
</div>
<?php
<?php
}
}
add_action('admin_notices', 'woocommerce_blocks_admin_unsupported_wp_notice');
add_action( 'admin_notices', 'woocommerce_blocks_admin_unsupported_wp_notice' );
return;
}

Expand All @@ -75,28 +72,27 @@ function woocommerce_blocks_admin_unsupported_wp_notice()
*
* @return bool True means the current version is a development version.
*/
function woocommerce_blocks_is_development_version()
{
function woocommerce_blocks_is_development_version() {
$composer_file = __DIR__ . '/composer.json';
if (!is_readable($composer_file)) {
if ( ! is_readable( $composer_file ) ) {
return false;
}
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- including local file
$composer_config = json_decode(file_get_contents($composer_file), true);
return !isset($composer_config['version']);
$composer_config = json_decode( file_get_contents( $composer_file ), true );
return ! isset( $composer_config['version'] );
}

/**
* If development version is detected and the Jetpack constant is not defined, show a notice.
*/
if (woocommerce_blocks_is_development_version() && !defined('JETPACK_AUTOLOAD_DEV')) {
if ( woocommerce_blocks_is_development_version() && ! defined( 'JETPACK_AUTOLOAD_DEV' ) ) {
add_action(
'admin_notices',
function () {
echo '<div class="error"><p>';
printf(
/* translators: %1$s is referring to a php constant name, %2$s is referring to the wp-config.php file. */
esc_html__('WooCommerce Blocks development mode requires the %1$s constant to be defined and true in your %2$s file. Otherwise you are loading the blocks package from WooCommerce core.', 'woo-gutenberg-products-block'),
esc_html__( 'WooCommerce Blocks development mode requires the %1$s constant to be defined and true in your %2$s file. Otherwise you are loading the blocks package from WooCommerce core.', 'woo-gutenberg-products-block' ),
'JETPACK_AUTOLOAD_DEV',
'wp-config.php'
);
Expand All @@ -116,16 +112,16 @@ function () {
* If the autoloader is not present, let's log the failure and display a nice admin notice.
*/
$autoloader = __DIR__ . '/vendor/autoload_packages.php';
if (is_readable($autoloader)) {
if ( is_readable( $autoloader ) ) {
require $autoloader;
} else {
if (defined('WP_DEBUG') && WP_DEBUG) {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
error_log( // phpcs:ignore
sprintf(
/* translators: 1: composer command. 2: plugin directory */
esc_html__('Your installation of the WooCommerce Blocks feature plugin is incomplete. Please run %1$s within the %2$s directory.', 'woo-gutenberg-products-block'),
esc_html__( 'Your installation of the WooCommerce Blocks feature plugin is incomplete. Please run %1$s within the %2$s directory.', 'woo-gutenberg-products-block' ),
'`composer install`',
'`' . esc_html(str_replace(ABSPATH, '', __DIR__)) . '`'
'`' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . '`'
)
);
}
Expand All @@ -135,26 +131,26 @@ function () {
add_action(
'admin_notices',
function () {
?>
?>
<div class="notice notice-error">
<p>
<?php
printf(
/* translators: 1: composer command. 2: plugin directory */
esc_html__('Your installation of the WooCommerce Blocks feature plugin is incomplete. Please run %1$s within the %2$s directory.', 'woo-gutenberg-products-block'),
esc_html__( 'Your installation of the WooCommerce Blocks feature plugin is incomplete. Please run %1$s within the %2$s directory.', 'woo-gutenberg-products-block' ),
'<code>composer install</code>',
'<code>' . esc_html(str_replace(ABSPATH, '', __DIR__)) . '</code>'
'<code>' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . '</code>'
);
?>
</p>
</div>
<?php
<?php
}
);
return;
}

add_action('plugins_loaded', array('\Automattic\WooCommerce\Blocks\Package', 'init'));
add_action( 'plugins_loaded', array( '\Automattic\WooCommerce\Blocks\Package', 'init' ) );

/**
* WordPress will look for translation in the following order:
Expand All @@ -171,9 +167,8 @@ function () {
*
* @return string|false Path to the translation file to load. False if there isn't one.
*/
function load_woocommerce_core_json_translation($file, $handle, $domain)
{
if ('woo-gutenberg-products-block' !== $domain) {
function load_woocommerce_core_json_translation( $file, $handle, $domain ) {
if ( 'woo-gutenberg-products-block' !== $domain ) {
return $file;
}

Expand All @@ -183,32 +178,32 @@ function load_woocommerce_core_json_translation($file, $handle, $domain)
* We only care about the translation file of the feature plugin in the
* wp-content/languages folder.
*/
if (false === strpos($file, $lang_dir)) {
if ( false === strpos( $file, $lang_dir ) ) {
return $file;
}

// If the translation file for feature plugin exist, use it.
if (is_readable($file)) {
if ( is_readable( $file ) ) {
return $file;
}

global $wp_scripts;

if (!isset($wp_scripts->registered[$handle], $wp_scripts->registered[$handle]->src)) {
if ( ! isset( $wp_scripts->registered[ $handle ], $wp_scripts->registered[ $handle ]->src ) ) {
return $file;
}

$handle_src = explode('/build/', $wp_scripts->registered[$handle]->src);
$handle_src = explode( '/build/', $wp_scripts->registered[ $handle ]->src );
$handle_filename = $handle_src[1];
$locale = determine_locale();
$lang_dir = WP_LANG_DIR . '/plugins';

// Translations are always based on the unminified filename.
if (substr($handle_filename, -7) === '.min.js') {
$handle_filename = substr($handle_filename, 0, -7) . '.js';
if ( substr( $handle_filename, -7 ) === '.min.js' ) {
$handle_filename = substr( $handle_filename, 0, -7 ) . '.js';
}

$core_path_md5 = md5('packages/woocommerce-blocks/build/' . $handle_filename);
$core_path_md5 = md5( 'packages/woocommerce-blocks/build/' . $handle_filename );

/**
* Return file path of the corresponding translation file in the WC Core is
Expand All @@ -218,7 +213,7 @@ function load_woocommerce_core_json_translation($file, $handle, $domain)
return $lang_dir . '/woocommerce-' . $locale . '-' . $core_path_md5 . '.json';
}

add_filter('load_script_translation_file', 'load_woocommerce_core_json_translation', 10, 3);
add_filter( 'load_script_translation_file', 'load_woocommerce_core_json_translation', 10, 3 );

/**
* Filter translations so we can retrieve translations from Core when the original and the translated
Expand All @@ -229,35 +224,33 @@ function load_woocommerce_core_json_translation($file, $handle, $domain)
* @param string $domain The text domain.
* @return string WC Blocks translation. In case it's the same as $text, Core translation.
*/
function woocommerce_blocks_get_php_translation_from_core($translation, $text, $domain)
{
if ('woo-gutenberg-products-block' !== $domain) {
function woocommerce_blocks_get_php_translation_from_core( $translation, $text, $domain ) {
if ( 'woo-gutenberg-products-block' !== $domain ) {
return $translation;
}

// When translation is the same, that could mean the string is not translated.
// In that case, load it from core.
if ($translation === $text) {
return translate($text, 'woocommerce'); // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction, WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.TextDomainMismatch
if ( $translation === $text ) {
return translate( $text, 'woocommerce' ); // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction, WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.TextDomainMismatch
}
return $translation;
}

add_filter('gettext', 'woocommerce_blocks_get_php_translation_from_core', 10, 3);
add_filter( 'gettext', 'woocommerce_blocks_get_php_translation_from_core', 10, 3 );

/**
* Add notice to the admin dashboard if the plugin is outdated.
*
* @see https://github.com/woocommerce/woocommerce-blocks/issues/5587
*/
function woocommerce_blocks_plugin_outdated_notice()
{
function woocommerce_blocks_plugin_outdated_notice() {
$is_active =
is_plugin_active('woo-gutenberg-products-block/woocommerce-gutenberg-products-block.php') ||
is_plugin_active('woocommerce-gutenberg-products-block/woocommerce-gutenberg-products-block.php') ||
is_plugin_active('woocommerce-blocks/woocommerce-gutenberg-products-block.php');
is_plugin_active( 'woo-gutenberg-products-block/woocommerce-gutenberg-products-block.php' ) ||
is_plugin_active( 'woocommerce-gutenberg-products-block/woocommerce-gutenberg-products-block.php' ) ||
is_plugin_active( 'woocommerce-blocks/woocommerce-gutenberg-products-block.php' );

if (!$is_active) {
if ( ! $is_active ) {
return;
}

Expand All @@ -268,17 +261,17 @@ function woocommerce_blocks_plugin_outdated_notice()
* the current path is from the WC Core, we can consider the plugin is
* outdated because Jetpack Autoloader always loads the newer package.
*/
if (!strpos($woocommerce_blocks_path, 'packages/woocommerce-blocks')) {
if ( ! strpos( $woocommerce_blocks_path, 'packages/woocommerce-blocks' ) ) {
return;
}

if (should_display_compatibility_notices()) {
?>
if ( should_display_compatibility_notices() ) {
?>
<div class="notice notice-warning">
<p><?php esc_html_e('You have WooCommerce Blocks installed, but the WooCommerce bundled version is running because it is more up-to-date. This may cause unexpected compatibility issues. Please update the WooCommerce Blocks plugin.', 'woo-gutenberg-products-block'); ?></p>
<p><?php esc_html_e( 'You have WooCommerce Blocks installed, but the WooCommerce bundled version is running because it is more up-to-date. This may cause unexpected compatibility issues. Please update the WooCommerce Blocks plugin.', 'woo-gutenberg-products-block' ); ?></p>
</div>
<?php
<?php
}
}

add_action('admin_notices', 'woocommerce_blocks_plugin_outdated_notice');
add_action( 'admin_notices', 'woocommerce_blocks_plugin_outdated_notice' );

0 comments on commit 0fecf2b

Please sign in to comment.