forked from VaLeXaR/wp-multilang
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
255 lines (196 loc) · 8.97 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
=== WP Multilang ===
Contributors: valexar
Donate link: https://www.liqpay.ua/en/checkout/card/valexar
Tags: localization, multilanguage, multilingual, translation, multilang
Requires at least: 4.7
Tested up to: 5.0
Stable tag: 2.3.0
Requires PHP: 5.6+
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Multilingual plugin for WordPress.
== Description ==
WP Multilang is a multilingual plugin for WordPress.
Translations of post types, taxonomies, meta fields, options, text fields in miltimedia files, menus, titles and text fields in widgets.
== Features of the plugin WP Multilang ==
* 100% free.
* Translation at PHP.
* Compatible with REST.
* Support configuration for translate multidimensional arrays in options, meta fields, post content.
* Support multisite.
* Support WordPress in sub-folder.
* Separate menu items, posts, terms, widgets, comments per language.
* Many filters for dynamic applying translation settings.
* No duplicate posts, terms, menus, widgets.
* No sub-domain for each language version.
* No additional tables in database.
* Possibility set many languages with one localization. For example, for localization in the region.
* Possibility to set custom locale for html(If installed locale is en_US, you can set locale like: en, en-UK, en-AU etc. Without installation another localization)
* Possibility for add new languages for any user with capability `manage_options`.
* Exist the role "Translator" for editing posts, terms. It can not publish or delete.
* No limits by languages or by possibilities.
== WP Multilang compatible with plugins ==
* ACF, ACF Pro
* WooCommerce
* WooCommerce Customizer
* Gutenberg
* Yoast Seo
* Contact Form 7 (added mail tag [_language] for send user language in mail)
* WPBakery Visual Composer
* Page Builder by SiteOrigin
* NextGEN Gallery
* All in One SEO Pack
* MailChimp for WordPress
* Newsletter
* Maps Builder
* Max Mega Menu
* MasterSlider
* WP-PageNavi
* BuddyPress
* Meta Slider
* TablePress
* Download Monitor (Redefine templates for links in your theme and translate link texts)
* Better Search
Manage translation settings via json.
Add in the root of your theme or plugin file `wpm-config.json`.
Sample configurations can be viewed in config files in folder 'configs' in root the plugin.
Configuration is updated after switching theme, enable or update any plugins.
The plugin has filters for dynamic application configuration for translate.
For turn off translation, set `null` into the desired configuration.
For example, you must turn off translation for a post type `post`.
There are two ways:
1. In json.
Create in root of a theme or a plugin file `wpm-config.json` with:
`{
"post_types": {
"post": null
}
}`
2. Through the filter.
Add in functions.php
`add_filter( 'wpm_post_post_config', '__return_null' );`
To enable translation pass an empty array in php `array()` or empty object in json `{}`.
Supports translation multidimensional array of options, meta fields and post_content.
Supports the removal of established localizations.
Supports translation via GET parameter. Add in the GET parameter `lang` code desired language.
Supports clean database of translations when removing the plugin. Translations are only removed from the built-in tables.
Supports import term translations from qTranslate(by Soft79).
Supports automatically redirect to the user's browser language, if he visits for the first time.
Ideal for developers.
For display language switcher in any place add the code to your template `if ( function_exists ( 'wpm_language_switcher' ) ) wpm_language_switcher ();`
Function accepts two parameters:
$type - 'list', 'dropdown', 'select'. Default - 'list'.
$show - 'flag', 'name', 'both'. Default - 'both'.
Or using the shortcode `wpm_lang_switcher`. It accept two not necessary parameters 'type' and 'show'.
Available features for translation:
`wpm_translate_url( $url, $language = '' );` - translate url
`wpm_translate_string( $string, $language = '' );` - translate multilingual string
`wpm_translate_value( $value, $language = '' );` - translate multidimensional array with multilingual strings
Update translation occurs at PHP. Therefore plugin has high adaptability, compatibility and easily integrates with other plugins. This is what distinguishes it among similar.
Available translation html tags by JS for strings what do not have WP filters before output.
Add your tags in config:
`
"admin_html_tags": {
"admin_screen_id": {
"attribute": [
"selector"
]
}
}
`
Where:
`admin_screen_id` - admin screen id.
`attribute` - attribute what need to translate. Available 'text' - for translate text node, 'value' - for translate form values. Or other tag attribute, like 'title', 'alt'.
`selector` - css selector for search needed tag. Each selector is a new array item.
If You need to add translation for multidimentional array for repeated elements You can use custom tag 'wpm_each' for set config to each element in array.
Example, add config for each item 'title' in custom post field array:
`
"post_fields": {
"custom_field": {
"wpm_each": {
"title": {}
}
}
}
`
For set translation uses the syntax:
`[:en]Donec vitae orci sed dolor[:de]Cras risus ipsum faucibus ut[:]`
Supports translating from syntax qTranslate, qTranslate-X, WPGlobus etc.
Compatible with REST-API.
Supports transfer the required translation through option `lang` in the GET request to REST.
Has the ability to keep recording the target language through the transmission parameter `lang` in the request.
== Migration from qTranslate-X ==
1. Before installing/uninstalling, make database backup.
2. Deactivate qTranslate-X.
3. Install and activate WP Multilang.
4. Create in root of your theme file ‘wpm-config.json’.
5. Add all needed post types, taxonomies, options, fields to ‘wpm-config.json’. Setting from qTranslate-X not importing.
6. Import term names from qTranslate.
7. Check that everything is okay.
8. If everything is okay, remove qTranslate-X. If not, make screenshots of errors, restore database from backup and add support issue with your screenshots and description of errors.
== Warning ==
Do not support different slug for each language(Yet).
Not compatible with:
- WP Maintenance
== Known issues ==
Function 'get_page_by_title' not working, because in title field are stored titles for all languages. Use function 'wpm_get_page_by_title( $title )' as solution.
NOTE: Because plugins have different ways of storing data, WP Multilang is not compatible with every single plugin out-of-the-box (mostly page builders). This may result in texts not being translatable or translations not being saved. Most of these issues can be resolved using the integration options (wpm-config.json or filters) of WP Multilang.
Please try WP Multilang in a test-environment before activating it on an existing production site and always make a backup before activating!
== Installation ==
1. Upload the plugin files to the `/wp-content/plugins/wp-multilang` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Adjust languages on WP Multilang Settings page.
== Upgrade Notice ==
Before installing or uninstalling make the site database backup before.
== Frequently Asked Questions ==
= I add new translation, but it rewrite another translation on different language. =
If you have opened several browser tabs for editing this post in different languages, translation will be saved for the language that you opened last.
== Screenshots ==
1. Settings page
2. Post list page
3. Taxonomy list page
4. Taxonomy edit page
5. Post edit page
== Changelog ==
= 2.3.0 =
- fixed compatibility with WordPress 5.0
- fixed compatibility with AIOSP
= 2.2.6 =
- added donate link to readme.txt
- fix display language name
- fix SiteOrigin Builder compatibility
- fix fatal error when a plugin is disabled
- fix translate REST requests in admin
= 2.2.5 =
- fixed Gutenberg compatibility
- fixed translation WC coupons
= 2.2.4 =
- added "no-cache" header in admin on language change
- added WC coupon for translating
- fixed compatibility with SiteOrigin
- fixed http to https redirect error
- fixed styles
= 2.2.3 =
- fix translate menu
- fix translating
- fix saving metabox
- fix set home url in subfolder
= 2.2.2 =
- added shortcode for display language switcher
- add filters for set json config files for integration
- fixed checking for ml strings
- fixed compatibility with Gutenberg
- fixed checking for JSON strings
- fixed regex for ml strings
= 2.2.1 =
- fixed escaping text. Have error on some sites.
- fixed ACF PRO menu integration. Have error on ACFv4.
= 2.2.0 =
- added alternate locale for opengraph in YOAST SEO
- added setting default translation
- fixed PHP notice in YOAST sitemap
- fixed compatibility with Gutenberg
- fixed compatibility with Buddypress
- fixed translate 'attr_escape'
- fixed adding custom fields to menu items
All changelog available on [GitHub](https://github.com/VaLeXaR/wp-multilang/releases).