diff --git a/composer.json b/composer.json
index 76a6f190..ec1b89d3 100644
--- a/composer.json
+++ b/composer.json
@@ -17,7 +17,8 @@
"phpstan/extension-installer": "^1.3",
"antecedent/patchwork": "^2.1",
"squizlabs/php_codesniffer": "^3.9",
- "phpcompatibility/php-compatibility": "^9.3"
+ "phpcompatibility/php-compatibility": "^9.3",
+ "wp-coding-standards/wpcs": "^3.0"
},
"autoload": {
"psr-4": {
@@ -38,7 +39,17 @@
"php82": "phpcs -p ./*.php includes/ --standard=vendor/phpcompatibility/php-compatibility/PHPCompatibility --runtime-set testVersion 8.2",
"prepare": "wget -O build/translations.json http://api.wordpress.org/translations/core/1.0/",
"flags-png": "php bin/flags-png.php > flags/flags.php",
- "flags-svg": "php bin/flags-svg.php > css/flags.php"
+ "flags-svg": "php bin/flags-svg.php > css/flags.php",
+ "githooks": [
+ "if [ -e ./githooks/pre-commit ]; then cp ./githooks/pre-commit ./.git/hooks/; fi",
+ "if [ -e ./.git/hooks/pre-commit ]; then chmod 0755 ./.git/hooks/pre-commit; fi"
+ ],
+ "post-install-cmd": [
+ "@githooks"
+ ],
+ "post-update-cmd": [
+ "@githooks"
+ ]
},
"authors": [
{
@@ -57,7 +68,8 @@
"config": {
"allow-plugins": {
"composer/installers": true,
- "phpstan/extension-installer": true
+ "phpstan/extension-installer": true,
+ "dealerdirect/phpcodesniffer-composer-installer": true
}
}
}
diff --git a/githooks/pre-commit b/githooks/pre-commit
new file mode 100644
index 00000000..dde95e1e
--- /dev/null
+++ b/githooks/pre-commit
@@ -0,0 +1,28 @@
+#!/bin/bash
+
+echo ""
+echo "phpcbf pre commit hook start"
+
+PHP_CS_FIXER="vendor/bin/phpcbf"
+HAS_PHP_CS_FIXER=false
+
+# check if php-cs-fixer is installed as a composer dependency
+if [ -x $PHP_CS_FIXER ]; then
+ HAS_PHP_CS_FIXER=true
+fi
+
+if $HAS_PHP_CS_FIXER; then
+
+ # gets a list of all staged but not deleted php-files
+ CHANGED_FILES=$(git diff --cached --name-only --diff-filter=ACMRTUXB HEAD | grep .php)
+
+ if [ ! -z "${CHANGED_FILES}" ]; then
+ # runs phpcbf on the changed files
+ vendor/bin/phpcbf -w --standard=WordPress ${CHANGED_FILES}
+ # adds the changed files to staging again
+ git add ${CHANGED_FILES}
+ fi
+fi
+
+echo "phpcbf pre commit hook finish"
+echo ""
diff --git a/includes/MslsPlugin.php b/includes/MslsPlugin.php
index 80f40e02..c476ad4c 100644
--- a/includes/MslsPlugin.php
+++ b/includes/MslsPlugin.php
@@ -1,6 +1,7 @@
* @since 0.9.8
*/
@@ -38,65 +39,72 @@ public function __construct( MslsOptions $options ) {
* @return MslsPlugin
*/
public static function init() {
- $obj = new self( msls_options() );
+ $obj = new self( msls_options() );
- add_action( 'plugins_loaded', [ $obj, 'init_i18n_support' ] );
+ add_action( 'plugins_loaded', array( $obj, 'init_i18n_support' ) );
- register_activation_hook( self::file(), [ $obj, 'activate' ] );
+ register_activation_hook( self::file(), array( $obj, 'activate' ) );
if ( function_exists( 'is_multisite' ) && is_multisite() ) {
- add_filter( 'msls_get_output', [ __CLASS__, 'get_output' ] );
+ add_filter( 'msls_get_output', array( __CLASS__, 'get_output' ) );
- add_action( 'widgets_init', [ $obj, 'init_widget' ] );
- add_filter( 'the_content', [ $obj, 'content_filter' ] );
+ add_action( 'widgets_init', array( $obj, 'init_widget' ) );
+ add_filter( 'the_content', array( $obj, 'content_filter' ) );
- add_action( 'wp_head', [ __CLASS__, 'print_alternate_links' ] );
+ add_action( 'wp_head', array( __CLASS__, 'print_alternate_links' ) );
if ( function_exists( 'register_block_type' ) ) {
- add_action( 'init', [ $obj, 'block_init' ] );
+ add_action( 'init', array( $obj, 'block_init' ) );
}
- add_action( 'init', [ $obj, 'admin_bar_init' ] );
- add_action( 'admin_enqueue_scripts', [ $obj, 'custom_enqueue' ] );
- add_action( 'wp_enqueue_scripts', [ $obj, 'custom_enqueue' ] );
+ add_action( 'init', array( $obj, 'admin_bar_init' ) );
+ add_action( 'admin_enqueue_scripts', array( $obj, 'custom_enqueue' ) );
+ add_action( 'wp_enqueue_scripts', array( $obj, 'custom_enqueue' ) );
\lloc\Msls\ContentImport\Service::instance()->register();
if ( is_admin() ) {
- add_action( 'admin_menu', [ MslsAdmin::class, 'init' ] );
- add_action( 'load-post.php', [ MslsMetaBox::class, 'init' ] );
- add_action( 'load-post-new.php', [ MslsMetaBox::class, 'init' ] );
- add_action( 'load-edit.php', [ MslsCustomColumn::class, 'init' ] );
- add_action( 'load-edit.php', [ MslsCustomFilter::class, 'init' ] );
+ add_action( 'admin_menu', array( MslsAdmin::class, 'init' ) );
+ add_action( 'load-post.php', array( MslsMetaBox::class, 'init' ) );
+ add_action( 'load-post-new.php', array( MslsMetaBox::class, 'init' ) );
+ add_action( 'load-edit.php', array( MslsCustomColumn::class, 'init' ) );
+ add_action( 'load-edit.php', array( MslsCustomFilter::class, 'init' ) );
- add_action( 'load-edit-tags.php', [ MslsCustomColumnTaxonomy::class, 'init' ] );
- add_action( 'load-edit-tags.php', [ MslsPostTag::class, 'init' ] );
- add_action( 'load-term.php', [ MslsPostTag::class, 'init' ] );
+ add_action( 'load-edit-tags.php', array( MslsCustomColumnTaxonomy::class, 'init' ) );
+ add_action( 'load-edit-tags.php', array( MslsPostTag::class, 'init' ) );
+ add_action( 'load-term.php', array( MslsPostTag::class, 'init' ) );
if ( filter_has_var( INPUT_POST, 'action' ) ) {
$action = filter_input( INPUT_POST, 'action', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
if ( 'add-tag' === $action ) {
- add_action( 'admin_init', [ MslsPostTag::class, 'init' ] );
+ add_action( 'admin_init', array( MslsPostTag::class, 'init' ) );
} elseif ( 'inline-save' === $action ) {
- add_action( 'admin_init', [ MslsCustomColumn::class, 'init' ] );
+ add_action( 'admin_init', array( MslsCustomColumn::class, 'init' ) );
} elseif ( 'inline-save-tax' === $action ) {
- add_action( 'admin_init', [ MslsCustomColumnTaxonomy::class, 'init' ] );
+ add_action( 'admin_init', array( MslsCustomColumnTaxonomy::class, 'init' ) );
}
}
- add_action( 'wp_ajax_suggest_posts', [ MslsMetaBox::class, 'suggest' ] );
- add_action( 'wp_ajax_suggest_terms', [ MslsPostTag::class, 'suggest' ] );
+ add_action( 'wp_ajax_suggest_posts', array( MslsMetaBox::class, 'suggest' ) );
+ add_action( 'wp_ajax_suggest_terms', array( MslsPostTag::class, 'suggest' ) );
}
} else {
- add_action( 'admin_notices', function () {
- $href = 'https://wordpress.org/support/article/create-a-network/';
- $msg = sprintf( __( 'The Multisite Language Switcher needs the activation of the multisite-feature for working properly. Please read this post if you don\'t know the meaning.',
- 'multisite-language-switcher' ),
- $href );
-
- self::message_handler( $msg );
- } );
+ add_action(
+ 'admin_notices',
+ function () {
+ $href = 'https://wordpress.org/support/article/create-a-network/';
+ $msg = sprintf(
+ __(
+ 'The Multisite Language Switcher needs the activation of the multisite-feature for working properly. Please read this post if you don\'t know the meaning.',
+ 'multisite-language-switcher'
+ ),
+ $href
+ );
+
+ self::message_handler( $msg );
+ }
+ );
}
return $obj;
@@ -129,12 +137,22 @@ public static function update_adminbar( \WP_Admin_Bar $wp_admin_bar ): void {
foreach ( $blog_collection->get_plugin_active_blogs() as $blog ) {
$title = $blog->get_blavatar() . $blog->get_title( $icon_type );
- $wp_admin_bar->add_node( [ 'id' => 'blog-' . $blog->userblog_id, 'title' => $title ] );
+ $wp_admin_bar->add_node(
+ array(
+ 'id' => 'blog-' . $blog->userblog_id,
+ 'title' => $title,
+ )
+ );
}
$blog = $blog_collection->get_current_blog();
if ( is_object( $blog ) && method_exists( $blog, 'get_title' ) ) {
- $wp_admin_bar->add_node( [ 'id' => 'site-name', 'title' => $blog->get_title( $icon_type ) ] );
+ $wp_admin_bar->add_node(
+ array(
+ 'id' => 'site-name',
+ 'title' => $blog->get_title( $icon_type ),
+ )
+ );
}
}
@@ -195,7 +213,7 @@ public function filter_string( $pref = '', $post = '
' ) {
$output = sprintf(
$output,
sprintf(
- __( '%s and %s', 'multisite-language-switcher' ),
+ __( '%1$s and %2$s', 'multisite-language-switcher' ),
implode( ', ', $links ),
$last
)
@@ -213,12 +231,13 @@ public function filter_string( $pref = '', $post = '
' ) {
/**
* Register block and shortcode.
+ *
* @return bool
*/
public function block_init() {
if ( ! $this->options->is_excluded() ) {
- register_block_type( self::plugin_dir_path('js/msls-widget-block' ) );
- add_shortcode( 'sc_msls_widget', [ $this, 'block_render' ] );
+ register_block_type( self::plugin_dir_path( 'js/msls-widget-block' ) );
+ add_shortcode( 'sc_msls_widget', array( $this, 'block_render' ) );
return true;
}
@@ -231,7 +250,7 @@ public function block_init() {
*/
public function admin_bar_init() {
if ( is_admin_bar_showing() && is_super_admin() ) {
- add_action( 'admin_bar_menu', [ __CLASS__, 'update_adminbar' ], 999 );
+ add_action( 'admin_bar_menu', array( __CLASS__, 'update_adminbar' ), 999 );
return true;
}
@@ -254,14 +273,11 @@ public function custom_enqueue() {
$ver = defined( 'MSLS_PLUGIN_VERSION' ) ? constant( 'MSLS_PLUGIN_VERSION' ) : false;
$folder = defined( 'SCRIPT_DEBUG' ) && constant( 'SCRIPT_DEBUG' ) ? 'src' : 'js';
- wp_enqueue_style( 'msls-styles', self::plugins_url( 'css/msls.css' ), [], $ver );
- wp_enqueue_style( 'msls-flags', self::plugins_url( 'css-flags/css/flag-icon.min.css' ), [], $ver );
+ wp_enqueue_style( 'msls-styles', self::plugins_url( 'css/msls.css' ), array(), $ver );
+ wp_enqueue_style( 'msls-flags', self::plugins_url( 'css-flags/css/flag-icon.min.css' ), array(), $ver );
if ( $this->options->activate_autocomplete ) {
- wp_enqueue_script( 'msls-autocomplete',
- self::plugins_url( "$folder/msls.js" ),
- [ 'jquery-ui-autocomplete' ],
- $ver );
+ wp_enqueue_script( 'msls-autocomplete', self::plugins_url( "$folder/msls.js" ), array( 'jquery-ui-autocomplete' ), $ver );
return true;
}
@@ -319,6 +335,7 @@ public static function path(): string {
*
* The widget will only be registered if the current blog is not
* excluded in the configuration of the plugin.
+ *
* @return boolean
*/
public function init_widget() {
@@ -384,7 +401,7 @@ public static function message_handler( $message, $css_class = 'error' ) {
* Activate plugin
*/
public static function activate() {
- register_uninstall_hook( self::file(), [ __CLASS__, 'uninstall' ] );
+ register_uninstall_hook( self::file(), array( __CLASS__, 'uninstall' ) );
}
/**
@@ -452,7 +469,7 @@ public static function cleanup() {
* @return array
*/
public static function get_superglobals( array $list ) {
- $arr = [];
+ $arr = array();
foreach ( $list as $var ) {
$arr[ $var ] = '';
@@ -466,5 +483,4 @@ public static function get_superglobals( array $list ) {
return $arr;
}
-
}
diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 00000000..7a28b9e0
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,153 @@
+
+
+
+ A custom set of rules to check for a WPized WordPress project
+
+
+
+ .
+
+
+ /docroot/wp-admin/*
+ /docroot/wp-includes/*
+ /docroot/wp-*.php
+ /docroot/index.php
+ /docroot/xmlrpc.php
+ /docroot/wp-content/plugins/*
+
+
+ /vendor/*
+
+
+ /node_modules/*
+
+
+ *.min.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ /path/to/Tests/*Test\.php
+
+
+ /path/to/Tests/*Test\.php
+
+
+
\ No newline at end of file