readme.txt

=== Multi Device Switcher ===

Contributors: thingsym
Link: https://github.com/thingsym/multi-device-switcher
Donate link: https://github.com/sponsors/thingsym
Tags: switcher, theme, ipad, iphone, android, tablet, mobile, game
Stable tag: 1.8.5
Tested up to: 6.6.1
Requires at least: 4.9
Requires PHP: 5.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Multi Device Switcher plugin allows you to set a separate theme for device (Smart Phone, Tablet PC, Mobile Phone, Game and custom).

== Description ==

Multi Device Switcher plugin allows you to set a separate theme for device (Smart Phone, Tablet PC, Mobile Phone, Game and custom).
This plugin detects if your site is being viewed by UserAgent, and switches to selected theme.
The Custom Switcher can add every device.

= Features =

* Set a separate theme for device (Smart Phone, Tablet PC, Mobile Phone, Game), switches to selected theme.
* Add every device by the **Custom Switcher**.
* Add links 'Mobile' or 'PC' in the theme by the **PC Switcher**, switch to the default theme.
* Switch the content of the post or page for each device by the **Display Switcher** Shortcode.
* Disable the switching of the theme for each url by the **Disable Switcher**.
* Can be using **is_multi_device()** function that detect of the device.
* **Multi Device Switcher Command** command-line tool (required WP-CLI)

= Support =

If you have any trouble, you can use the forums or report bugs.

* Forum: [https://wordpress.org/support/plugin/multi-device-switcher/](https://wordpress.org/support/plugin/multi-device-switcher/)
* Issues: [https://github.com/thingsym/multi-device-switcher/issues](https://github.com/thingsym/multi-device-switcher/issues)

= Contribution =

Small patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.

Translating a plugin takes a lot of time, effort, and patience. I really appreciate the hard work from these contributors.

If you have created or updated your own language pack, you can send gettext PO and MO files to author. I can bundle it into plugin.

* [VCS - GitHub](https://github.com/thingsym/multi-device-switcher)
* [Homepage - WordPress Plugin](https://wordpress.org/plugins/multi-device-switcher/)
* [Translate Multi Device Switcher into your language.](https://translate.wordpress.org/projects/wp-plugins/multi-device-switcher)

You can also contribute by answering issues on the forums.

* Forum: [https://wordpress.org/support/plugin/multi-device-switcher/](https://wordpress.org/support/plugin/multi-device-switcher/)
* Issues: [https://github.com/thingsym/multi-device-switcher/issues](https://github.com/thingsym/multi-device-switcher/issues)

= Patches and Bug Fixes =

Forking on Github is another good way. You can send a pull request.

1. Fork [Multi Device Switcher](https://github.com/thingsym/multi-device-switcher) from GitHub repository
2. Create a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Create new Pull Request

= Contribute guidlines =

If you would like to contribute, here are some notes and guidlines.

* All development happens on the **develop** branch, so it is always the most up-to-date
* The **master** branch only contains tagged releases
* If you are going to be submitting a pull request, please submit your pull request to the **develop** branch
* See about [forking](https://help.github.com/articles/fork-a-repo/) and [pull requests](https://help.github.com/articles/using-pull-requests/)

= Test Matrix =

For operation compatibility between PHP version and WordPress version, see below [Github Actions](https://github.com/thingsym/multi-device-switcher/actions).

= Known bugs =

WordPress Core version 6.4 - 6.4.1

* Theme doesn't switch properly
* Bug report: https://core.trac.wordpress.org/ticket/59847
* It seems to have been caused by a change (breaking change) at https://core.trac.wordpress.org/changeset/56635. The bug is fixed in https://core.trac.wordpress.org/changeset/57129 (fixed in WordPress 6.4.2)

== Screenshots ==

1. Theme option
2. UserAgent option
3. PC Switcher option
4. PC Switcher button
5. Disable Switcher

== Installation ==

1. Download and unzip files. Or install multi-device-switcher using the WordPress plugin installer. In that case, skip 2.
2. Upload "multi-device-switcher" to the "/wp-content/plugins/" directory.
3. Activate the plugin through the 'Plugins' menu in WordPress.
4. Upload a separate theme to the "/wp-content/themes/" directory.
5. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
6. Configure settings to your needs. Select Theme by Theme option. Add and fix UserAgent by UserAgent option if necessary.
7. Have fun!

= How to add the Custom Switcher =

1. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
2. Enter the name of the Custom Switcher (20 characters max, alphanumeric) to the 'Add Custom Switcher'. Push the button 'Add'.
3. Configure settings. Select Theme by Theme option. Add UserAgent by UserAgent option.
4. Have fun!

= Setting and Using the PC Switcher =

There are three ways how to Using the PC Switcher.

= 1. Add a PC Switcher to the footer =

1. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
2. Configure settings. Check the checkbox 'Add a PC Switcher to the footer.' by PC Switcher option.
3. Have fun!

= 2. Add a PC Switcher to your sidebars/widget areas =

1. Add-on the widget 'PC Switcher', when you activate the plugin "Multi Device Switcher".
2. Go to the "Widgets" options page through the 'Appearance' menu in WordPress.
3. Drag and drop the title bars 'PC Switcher' into the desired area.
4. Have fun!

= 3. For the theme authors and developers, add a PC Switcher to your theme. =

1. Add the following code into the PHP files, when you develop your theme.

 `<?php if ( function_exists('multi_device_switcher_add_pc_switcher') ) { multi_device_switcher_add_pc_switcher(); } ?>`
2. Have fun!

= Using default CSS and customized CSS =

* Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
* Configure settings. Check the checkbox 'Add a default CSS.' by PC Switcher option. If you want to customize CSS, uncheck the checkbox.
* Have fun!

You can design the PC Switcher in the Style Sheet.

**HTML output of the PC Switcher**

`
 <div class="pc-switcher"><span class="active">Mobile</span><a href="http://DOMEIN/PATH/TO/?pc-switcher=1">PC</a></div>
`

**HTML output of the PC Switcher when switched**

`
 <div class="pc-switcher"><a href="http://DOMEIN/PATH/TO/?pc-switcher=0">Mobile</a><span class="active">PC</span></div>
`

= How to use the Display Switcher Shortcode =

The **Display Switcher** Shortcode switch the content of the post or page through the detection of the device.

Add the shortcode `[multi]` in a post or page and use the `device` attribute to device name. if the device attribute is empty, detect the desktop PC.

= Attributes =

**device**

(string | empty) The name of the device

* smart
* tablet
* mobile
* game
* the name of the Custom Switcher

if empty, detect the desktop PC

= Example Shortcode =

`
[multi]pc or other specific stuff here[/multi]
[multi device="smart"]smartphone specific stuff here[/multi]
[multi device="tablet"]tablet specific stuff here[/multi]
[multi device="test"]test Custom Switcher specific stuff here[/multi]
`

For theme or plugin developers. Filters The Display Switcher Shortcode through hooks. In that case, edit theme or plugin files.

`
<?php
echo do_shortcode('[multi device="smart"]smartphone specific stuff here[/multi]');
?>
`

= How to use the Disable Switcher =

The **Disable Switcher** disable the switching of the theme by a particular URL. If you match the access the url and a string or a regular expression (Regex mode), disable the switching of the theme. Regex mode is for advanced users.

1. Go to the "Multi Device Switcher" options page through the 'Appearance' menu in WordPress.
2. Enter the path to the line by line where you want to disable by Disable Switcher option. Check the checkbox 'Enable Regex', if you want to use a regular expression.
3. Have fun!

= Example =

`
/sample-page
/2015/01/hello-world
`

= Regex mode (in the case of regular expression) =

`
\/sample\-
\/2015\/01
`

= UserAgent option Samples =

* [Default UserAgent](https://github.com/thingsym/multi-device-switcher/wiki/Default-UserAgent)

= Detect the device by JavaScript =

Multi Device Switcher set the Cookie that holds the state of the switch. You can get the Cookie and detect the device by JavaScript.

= Cookies =

* `multi-device-switcher` The name of the device is switched (value: null | device name)
* `disable-switcher` State of disabled (value: null | 1)
* `pc-switcher` State of the PC Switcher when switched (value: null | 1)

= Example =

`
 <script src="http://DOMEIN/PATH/TO/jquery.cookie.js"></script>
 <script>
 (function($) {
 	$(function() {
 		if ( $.cookie( 'multi-device-switcher' ) == 'smart' ) {
 			/* smartphone specific stuff here */
 		} else if ( $.cookie( 'multi-device-switcher' ) == 'tablet' ) {
 			/* tablet specific stuff here */
 		} else {
 			/* pc or other specific stuff here */
 		}
 	});
 })(jQuery);
 </script>
`

= is_multi_device() function =

**is_multi_device()** function is a boolean function, meaning it returns either TRUE or FALSE. Works through the detection of the device by the Multi_Device_Switcher class.

= Usage =

`
<?php is_multi_device('smart'); ?>
`

= Example =

`
<?php
if ( function_exists( 'is_multi_device' ) ) {
	if ( is_multi_device('smart') ) {
		/* Display and echo smartphone specific stuff here */
	} elseif ( is_multi_device('tablet') ) {
		/* Display and echo tablet specific stuff here */
	} else {
		/* Display and echo pc or other specific stuff here */
	}
}
?>
`

= Parameters =

**device name** (required)

(string) The name of the device

* smart
* tablet
* mobile
* game
* the name of the Custom Switcher

= Return Values =

(boolean) Return boolean whether a particular device.

= is_pc_switcher() function =

**is_pc_switcher()** function is a boolean function, meaning it returns either TRUE or FALSE. Return the the state of PC Switcher by the Multi_Device_Switcher class. Return true if the theme has switched by the PC Switcher.

=  Usage =

`
<?php is_pc_switcher(); ?>
`

= Example =

`
<?php
if ( function_exists( 'is_pc_switcher' ) ) {
	if ( is_pc_switcher() ) {
		/* Theme switched by the PC Switcher. Display and echo specific stuff here */
	} else {
		/* Display and echo specific stuff here */
	}
}
?>
`

= Parameters =

None

= Return Values =

(boolean) Return the state of PC Switcher.

= is_disable_switcher() function =

**is_disable_switcher()** function is a boolean function, meaning it returns either TRUE or FALSE. Return the state of disabled by the Multi_Device_Switcher class.

= Usage =

`
<?php is_disable_switcher(); ?>
`

= Example =

`
<?php
if ( function_exists( 'is_disable_switcher' ) ) {
	if ( is_disable_switcher() ) {
		/* Disabled. Display and echo specific stuff here */
	} else {
		/* Display and echo specific stuff here */
	}
}
?>
`

= Parameters =

None

= Return Values =

(boolean) Return the state of disabled.

= Filter hooks =

* multi_device_switcher/get_options
* multi_device_switcher/get_option
* multi_device_switcher/add_header_vary
* multi_device_switcher/validate_options

= Action hooks =

* multi_device_switcher/detect_device

= Multi Device Switcher Command =

The **Multi Device Switcher Command** is command-line tool.

Add-on the Multi Device Switcher Command, when you activate the plugin "Multi Device Switcher". To use the Multi Device Switcher Command is WP-CLI required.

= NAME =

`
wp multi-device
`

= DESCRIPTION =

`
Multi Device Switcher Command
`

= SYNOPSIS =

`
wp multi-device <command>
`

= SUBCOMMANDS =

`
add              add Custom Switcher
css              turn on/off default CSS
delete           delete Custom Switcher
pc-switcher      turn on/off PC Switcher
reset            reset Settings to Default UserAgent
status           get status of settings
theme            get or switch a theme
useragent        get or set UserAgent
`

For more information about the Multi Device Switcher Command, see `wp help multi-device <SUBCOMMANDS>`.

== Changelog ==

= 1.8.5 =
* add phpcs job to ci
* add healthcheck to database container
* add bats test to ci
* fix bats test case
* add test case
* fix phpcs.ruleset.xml
* add enqueue_styles method
* imporve code with phpcs
* fix composer scripts
* update github actions

= 1.8.4 =
* tested up to 6.1.0
* update japanese translation
* update pot
* fix composer.json
* add test case
* update useragent
* fix load_textdomain method for testability
* add msgmerge to composer scripts
* add support section and enhance contribution section
* fix license

= 1.8.3 =
* update japanese translation
* update pot
* add composer script
* change makepot from php script to wp cli
* change plugin initialization to plugins_loaded hook
* replace assert from assertEquals to assertSame

= 1.8.2 =
* change requires at least to wordpress 4.9
* change requires to PHP 5.6
* add test case
* set the initial value an empty array
* add hook_suffix argument

= 1.8.1 =
* update japanese translation
* update pot
* imporve code with phpcs
* update wordpress-test-matrix
* fix test case
* fix plugin_metadata_links method
* add load_plugin_data method
* rename variable from options to option_name
* add test case for customizer
* rename method name
* update composer dependencies
* change from protected variable to public variable for unit test
* add timeout-minutes to workflows
* add phpunit-polyfills
* update install-wp-tests.sh
* tested up to 5.8.0
* fix .editorconfig

= 1.8.0 =
* add PHPDoc
* update japanese translation
* update pot
* fix composer.json
* add FUNDING.yml
* change donate link
* add sponsor link
* add GitHub actions for CI/CD, remove .travis.yml

= 1.7.0 =
* add test case for cdn
* add multi_device_switcher/detect_device action hook
* split switch_theme method into detect_device and switch_theme
* fix wp-cli
* add bats test case for cli
* refactoring with phpstan
* fix default options via method
* change tag name
* change method name
* improve get_options method
* replace from get_default_options() to class value default_options
* fix not valid snake_case format
* add public as access modifier keywords
* add PHPDoc
* add reset-wp-tests.sh, uninstall-wp-tests.sh
* fix header
* fix textdomain
* fix indent and reformat with phpcs and phpcbf
* add composer.json for test
* add static code analysis config

= 1.6.2 =
* add prefix into hook tag, change tag name from add_header_vary to multi_device_switcher_add_header_vary
* for php5.3, change called function via hook from anonymous function to public function

= 1.6.1 =
* add test cases
* add add_header_vary filter
* improve cookie settings via wp_headers hook
* change readme.md file name to upper case
* add LICENSE file

= 1.6.0 =
* change Requires at least version 3.7
* remove cache with PC Switcher widget
* add init function
* change hook destination from plugin_action_links to plugin_action_links_{$plugin_file}
* add load_textdomain function
* add define variable \_\_MULTI_DEVICE_SWITCHER_FILE\_\_
* check class Multi_Device_Switcher
* check ABSPATH
* add isset to conditional statement
* fix boolean
* add tests

= 1.5.4 =
* fixed: fix property keyword for testability
* fixed: fix add_action 'customize_register' with \_\_construct()
* fixed: fix capability

= 1.5.3 =
* fixed: add function multi_device_switcher_get_default_options for wp multi-device [#9](https://github.com/thingsym/multi-device-switcher/pull/9)

= 1.5.2 =
* fixed: fix setcookie() [#8](https://github.com/thingsym/multi-device-switcher/pull/8)

= 1.5.1 =
* fixed: fix preg_split()

= 1.5.0 =
* fixed: refactoring by the PHP_CodeSniffer
* fixed: change admin functions to class/object methods

= 1.4.2 =
* edited: edit readme
* new features: Display Switcher Shortcode
* updated: update default UserAgent
* fixed: fix pc-switcher ssl url

= 1.4.1 =
* edited: edit readme
* new features: is_disable_switcher() function
* new features: is_pc_switcher() function
* fixed: fix redirect url and pc-switcher url

= 1.4.0 =
* edited: edit readme
* added: add cookies 'multi-device-switcher', 'disable-switcher'
* new features: Disable Switcher
* fixed: fix get_options_userAgent(), multi_device_switcher_get_options()
* fixed: add reserved words validate
* new features: Multi Device Switcher Command
* added: add option settings into Theme Customizer
* fixed: refactoring by the PHP_CodeSniffer

= 1.3.0 =
* fixed: fix script, style, html and readme
* new features: is_multi_device() function
* fixed: fix translation
* updated: update default UserAgent
* fixed: replace WP_PLUGIN_URL with plugins_url()
* fixed: using Page Hook Suffix
* merged: pull request [#3](https://github.com/thingsym/multi-device-switcher/pull/3)

= 1.2.3 =
* fixed: fix redirect uri with query string, using add_query_arg
* fixed: fix translation
* fixed: fix readme

= 1.2.2 =
* improved: improve responsiveness UI
* fixed: fix html

= 1.2.1 =
* fixed: delete add_contextual_help
* fixed: fix readme and html

= 1.2.0 =
 * added: add PC Switcher Widget
 * new features: PC Switcher
 * added: add the settings link to the plugin page

= 1.1.2 =
* required: at least version 3.4
* fixed: fix tabs and buttons

= 1.1.1 =
* fixed: change the order of the UserAgent detection
* updated: update default UserAgent
* added: add HTTP/1.1 Vary header

= 1.1.0 =
* new features: Custom Switcher

= 1.0.4 =
* fixed: fix the object model PHP5, __construct() to replace Multi_Device_Switcher
* fixed: wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme()

= 1.0.3 =
* updated: update screenshots
* fixed: fix reset button

= 1.0.2 =
* added: add file uninstall.php
* fixed: split admin_enqueue_scripts() into two functions
* fixed: detects is_admin()

= 1.0.1 =
* fixed: split multi_device_switcher_init() into two functions

= 1.0.0 =
* Initial release

== Upgrade Notice ==

= 1.8.2 =
* Requires at least version 4.9 of the WordPress
* Requires PHP version 5.6

= 1.6.0 =
* Requires at least version 3.7 of the WordPress

= 1.1.2 =
* Requires at least version 3.4 of the WordPress