Add support for WPML (plugin / add-ons) #42

Spidlace · 2022-12-20T14:17:59Z

Checklist:

I've read the Contributing page.
I've created an issue and referenced it here.
My code is tested.
My code follows the WordPress code style.
My code has proper inline documentation.

Description

Add support for WPML plugin and add-ons

MouseEatsCat · 2022-12-20T21:27:48Z

plugins/WPML.php

+            'wpml-translation-management' => 6094,
+        ];
+
+        if (in_array($this->slug, $packages)) {


in_array should be replaced with array_key_exists

You're right, my bad!
It's modified! :-)

MouseEatsCat

I tested this on a project with several WPML add-ons and it seems to work well!

mcaskill

This feature is much appreciated.

I have not tested it myself yet but I propose a few minor changes to match the coding style of the rest of the package.

mcaskill · 2022-12-21T04:25:34Z

plugins/WPML.php

+/**
+ * ACF Pro Plugin.
+ *
+ * @package Junaidbhura\Composer\WPProPlugins\Plugins
+ */


Change file block comment to reflect WPML plugin.

Suggested change

/**

* ACF Pro Plugin.

*

* @package Junaidbhura\Composer\WPProPlugins\Plugins

*/

/**

* WPML Plugin.

*

* @package Junaidbhura\Composer\WPProPlugins\Plugins

*/

mcaskill · 2022-12-21T04:28:23Z

plugins/WPML.php

+/**
+ * AcfPro class.
+ */
+class WPML {


Change class block comment to reflect WPML plugin.

Rename the class and file name to CamelCase to reflect the other plugin class names.

Suggested change

/**

* AcfPro class.

*/

class WPML {

/**

* Wpml class.

*/

class Wpml {

mcaskill · 2022-12-21T04:30:01Z

plugins/WPML.php

+    /**
+     * WpAiPro constructor.
+     *
+     * @param string $version
+     * @param string $slug
+     */


Change method block comment to reflect WPML plugin.

Suggested change

/**

* WpAiPro constructor.

*

* @param string $version

* @param string $slug

*/

/**

* Wpml constructor.

*

* @param string $version

* @param string $slug

*/

mcaskill · 2022-12-21T04:34:10Z

plugins/WPML.php

+        $packages = [
+            'wpml-sitepress-multilingual-cms' => 6088,
+            'wpml-string-translation' => 6092,
+            'wpml-media-translation' => 7474,
+            'wpml-woocommerce-multilingual' => 637370,
+            'wpml-gravityforms-multilingual' => 8882,
+            'wpml-contact-form-7-multilingual' => 3156699,
+            'wpml-ninja-forms' => 5342487,
+            'wpml-wpforms' => 5368995,
+            'wpml-buddypress-multilingual' => 2216259,
+            'wpml-acfml' => 1097589,
+            'wpml-all-import' => 720221,
+            'wpml-mailchimp-for-wp' => 1442229,
+            'wpml-wp-seo-multilingual' => 3566177,
+            'wpml-types' => 1385906,
+            'wpml-sticky-links' => 6090,
+            'wpml-cms-nav' => 6096,
+            'wpml-translation-management' => 6094,
+        ];


Change to verbose array syntax and aligned array values to match coding style other classes.

Suggested change

$packages = [

'wpml-sitepress-multilingual-cms' => 6088,

'wpml-string-translation' => 6092,

'wpml-media-translation' => 7474,

'wpml-woocommerce-multilingual' => 637370,

'wpml-gravityforms-multilingual' => 8882,

'wpml-contact-form-7-multilingual' => 3156699,

'wpml-ninja-forms' => 5342487,

'wpml-wpforms' => 5368995,

'wpml-buddypress-multilingual' => 2216259,

'wpml-acfml' => 1097589,

'wpml-all-import' => 720221,

'wpml-mailchimp-for-wp' => 1442229,

'wpml-wp-seo-multilingual' => 3566177,

'wpml-types' => 1385906,

'wpml-sticky-links' => 6090,

'wpml-cms-nav' => 6096,

'wpml-translation-management' => 6094,

];

$packages = array(

'wpml-sitepress-multilingual-cms' => 6088,

'wpml-string-translation' => 6092,

'wpml-media-translation' => 7474,

'wpml-woocommerce-multilingual' => 637370,

'wpml-gravityforms-multilingual' => 8882,

'wpml-contact-form-7-multilingual' => 3156699,

'wpml-ninja-forms' => 5342487,

'wpml-wpforms' => 5368995,

'wpml-buddypress-multilingual' => 2216259,

'wpml-acfml' => 1097589,

'wpml-all-import' => 720221,

'wpml-mailchimp-for-wp' => 1442229,

'wpml-wp-seo-multilingual' => 3566177,

'wpml-types' => 1385906,

'wpml-sticky-links' => 6090,

'wpml-cms-nav' => 6096,

'wpml-translation-management' => 6094,

);

mcaskill · 2022-12-21T04:36:53Z

plugins/WPML.php

+        if (array_key_exists($this->slug, $packages)) {
+            return 'https://wpml.org/?download='. $packages[$this->slug] .'&user_id='. getenv( 'WPML_USER_ID' ) .'&subscription_key='. getenv( 'WPML_KEY' ) .'&version=' . $this->version;
+        }


Added spacing to match coding style other classes.

Suggested change

if (array_key_exists($this->slug, $packages)) {

return 'https://wpml.org/?download='. $packages[$this->slug] .'&user_id='. getenv( 'WPML_USER_ID' ) .'&subscription_key='. getenv( 'WPML_KEY' ) .'&version=' . $this->version;

}

if ( array_key_exists( $this->slug, $packages ) ) {

return 'https://wpml.org/?download=' . $packages[$this->slug] . '&user_id='. getenv( 'WPML_USER_ID' ) . '&subscription_key=' . getenv( 'WPML_KEY' ) . '&version=' . $this->version;

}

junaidbhura · 2023-01-01T20:53:48Z

Thanks everyone, happy new year!

Hey @Spidlace could you please implement the suggestions from @mcaskill ?

I'll be happy to merge it in once done. I'll make some minor updates once merged. I don't have an API key, @mcaskill have you verified this as working?

mcaskill · 2023-01-02T04:10:14Z

[…] I don't have an API key, @mcaskill have you verified this as working?

My colleague, @MouseEatsCat, and I have tried it.

junaidbhura · 2023-01-02T05:41:39Z

Okay excellent @mcaskill - will wait for @Spidlace to implement the suggestions before merging it in

mcaskill · 2023-01-18T17:01:07Z

plugins/WPML.php

+     * @param string $version
+     * @param string $slug
+     */
+    public function __construct( $version = '', $slug = 'sitepress-multilingual-cms' ) {


Fix the default slug to match the array key below.

Suggested change

public function __construct( $version = '', $slug = 'sitepress-multilingual-cms' ) {

public function __construct( $version = '', $slug = 'wpml-sitepress-multilingual-cms' ) {

mcaskill

I noticed that the Wpml.php file is using spaces instead of tabs. That should also be fixed.

mcaskill · 2023-01-18T17:28:12Z

README.md

+### WPML Add-Ons
+
+You can use any WPML add-on by simply adding it's slug like so:
+
+`junaidbhura/<plugin-slug>`
+
+For example:
+
+`junaidbhura/wpml-sitepress-multilingual-cms`
+
+`junaidbhura/wpml-string-translation`
+
+`junaidbhura/wpml-media-translation`
+
+`junaidbhura/wpml-woocommerce-multilingual`
+
+`junaidbhura/wpml-gravityforms-multilingual`
+
+`junaidbhura/wpml-contact-form-7-multilingual`
+
+`junaidbhura/wpml-ninja-forms`
+
+`junaidbhura/wpml-wpforms`
+
+`junaidbhura/wpml-buddypress-multilingual`
+
+`junaidbhura/wpml-acfml`
+
+`junaidbhura/wpml-all-import`
+
+`junaidbhura/wpml-mailchimp-for-wp`
+
+`junaidbhura/wpml-wp-seo-multilingual`
+
+`junaidbhura/wpml-types`
+
+`junaidbhura/wpml-sticky-links`
+
+`junaidbhura/wpml-cms-nav`
+
+`junaidbhura/wpml-translation-management`


This section is derived from from WP All Import/Export Pro and both should be rephrased to highlight the fact that only specific add-ons of each plugin are supported. The section should be phrase as so:

Suggested change

### WPML Add-Ons

You can use any WPML add-on by simply adding it's slug like so:

`junaidbhura/<plugin-slug>`

For example:

`junaidbhura/wpml-sitepress-multilingual-cms`

`junaidbhura/wpml-string-translation`

`junaidbhura/wpml-media-translation`

`junaidbhura/wpml-woocommerce-multilingual`

`junaidbhura/wpml-gravityforms-multilingual`

`junaidbhura/wpml-contact-form-7-multilingual`

`junaidbhura/wpml-ninja-forms`

`junaidbhura/wpml-wpforms`

`junaidbhura/wpml-buddypress-multilingual`

`junaidbhura/wpml-acfml`

`junaidbhura/wpml-all-import`

`junaidbhura/wpml-mailchimp-for-wp`

`junaidbhura/wpml-wp-seo-multilingual`

`junaidbhura/wpml-types`

`junaidbhura/wpml-sticky-links`

`junaidbhura/wpml-cms-nav`

`junaidbhura/wpml-translation-management`

### WPML Add-Ons

The following WPML plugins and add-ons are supported:

* `junaidbhura/wpml-acfml`

* `junaidbhura/wpml-all-import`

* `junaidbhura/wpml-buddypress-multilingual`

* `junaidbhura/wpml-cms-nav`

* `junaidbhura/wpml-contact-form-7-multilingual`

* `junaidbhura/wpml-gravityforms-multilingual`

* `junaidbhura/wpml-mailchimp-for-wp`

* `junaidbhura/wpml-media-translation`

* `junaidbhura/wpml-ninja-forms`

* `junaidbhura/wpml-sitepress-multilingual-cms`

* `junaidbhura/wpml-sticky-links`

* `junaidbhura/wpml-string-translation`

* `junaidbhura/wpml-translation-management`

* `junaidbhura/wpml-types`

* `junaidbhura/wpml-woocommerce-multilingual`

* `junaidbhura/wpml-wp-seo-multilingual`

* `junaidbhura/wpml-wpforms`

mcaskill · 2023-01-20T18:18:24Z

README.md

+  },
+
 ],


Fix JSON syntax.

Suggested change

},

],

}

],

mcaskill · 2023-02-01T20:02:38Z

Hi @Spidlace,

I hope you are doing well.

Will you be able to work on requested changes any time soon?
Alternatively, if your branch could add me as a contributor, I can make the changes for you.

Thanks and take care,

mcaskill · 2023-03-06T21:22:35Z

I've merged my suggestions in my fork, including some alleviation to the WPML code samples in the README.

I could create a separate pull request if we want to merge this feature sooner.

junaidbhura · 2023-03-06T21:23:42Z

@mcaskill Shall we close this PR in favour and maybe you could create a new PR instead?

junaidbhura · 2023-03-06T21:37:24Z

Closing in favour of #53

Anthony Martin added 2 commits December 20, 2022 15:13

Add support for WPML (Main plugin and Add-Ons)

5c66f39

Add support for WPML (Main plugin and Add-Ons)

e4c63d8

Spidlace mentioned this pull request Dec 20, 2022

Add support for WPML (plugin / add-ons) #43

Closed

MouseEatsCat suggested changes Dec 20, 2022

View reviewed changes

Change in_array to array_key_exists

cee6599

MouseEatsCat approved these changes Dec 20, 2022

View reviewed changes

mcaskill suggested changes Dec 21, 2022

View reviewed changes

mcaskill suggested changes Jan 18, 2023

View reviewed changes

mcaskill suggested changes Jan 20, 2023

View reviewed changes

README.md

Comment on lines +443 to 445

},

],

Copy link

Contributor

mcaskill Jan 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix JSON syntax.

Suggested change

},

],

}

],

mcaskill mentioned this pull request Mar 6, 2023

Add support for WPML (plugin / add-ons) #53

Merged

5 tasks

junaidbhura closed this Mar 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for WPML (plugin / add-ons) #42

Add support for WPML (plugin / add-ons) #42

Spidlace commented Dec 20, 2022 •

edited

Loading

MouseEatsCat Dec 20, 2022

Spidlace Dec 20, 2022

MouseEatsCat left a comment

mcaskill left a comment

mcaskill Dec 21, 2022

mcaskill Dec 21, 2022

mcaskill Dec 21, 2022

mcaskill Dec 21, 2022

mcaskill Dec 21, 2022

junaidbhura commented Jan 1, 2023

mcaskill commented Jan 2, 2023 •

edited

Loading

junaidbhura commented Jan 2, 2023

mcaskill Jan 18, 2023

mcaskill left a comment

mcaskill Jan 18, 2023

mcaskill Jan 20, 2023

mcaskill commented Feb 1, 2023

mcaskill commented Mar 6, 2023

junaidbhura commented Mar 6, 2023

junaidbhura commented Mar 6, 2023

	public function __construct( $version = '', $slug = 'sitepress-multilingual-cms' ) {
	public function __construct( $version = '', $slug = 'wpml-sitepress-multilingual-cms' ) {

-  },
-],
+  }
+],

Add support for WPML (plugin / add-ons) #42

Add support for WPML (plugin / add-ons) #42

Conversation

Spidlace commented Dec 20, 2022 • edited Loading

Checklist:

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MouseEatsCat left a comment

Choose a reason for hiding this comment

mcaskill left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

junaidbhura commented Jan 1, 2023

mcaskill commented Jan 2, 2023 • edited Loading

junaidbhura commented Jan 2, 2023

Choose a reason for hiding this comment

mcaskill left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcaskill commented Feb 1, 2023

mcaskill commented Mar 6, 2023

junaidbhura commented Mar 6, 2023

junaidbhura commented Mar 6, 2023

Spidlace commented Dec 20, 2022 •

edited

Loading

mcaskill commented Jan 2, 2023 •

edited

Loading