jetpack / modules / widgets / google-translate.php

google-translate.php in Jetpack – WP Security, Backup, Speed, & Growth 16.2, at modules/widgets/google-translate.php

227 lines 6.4 KB

Raw Download Zip

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Plugin Name: Google Translate Widget for WordPress.com
4	* Plugin URI: https://automattic.com
5	* Description: Add a widget for automatic translation
6	* Author: Artur Piszek
7	* Version: 0.1
8	* Author URI: https://automattic.com
9	* Text Domain: jetpack
10	*/
11
12	// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
13
14	use Automattic\Jetpack\Assets;
15
16	if ( ! defined( 'ABSPATH' ) ) {
17	exit( 0 );
18	}
19
20	/**
21	* Jetpack_Google_Translate_Widget main class.
22	*/
23	class Jetpack_Google_Translate_Widget extends WP_Widget {
24	/**
25	* Singleton instance of the widget, not to show more than once.
26	*
27	* @var array
28	*/
29	public static $instance = null;
30
31	/**
32	* Default widget title.
33	*
34	* @var string $default_title
35	*/
36	public $default_title;
37
38	/**
39	* Register widget with WordPress.
40	*/
41	public function __construct() {
42	parent::__construct(
43	'google_translate_widget',
44	/** This filter is documented in modules/widgets/facebook-likebox.php */
45	apply_filters( 'jetpack_widget_name', __( 'Google Translate', 'jetpack' ) ),
46	array(
47	'description' => __( 'Provide your readers with the option to translate your site into their preferred language.', 'jetpack' ),
48	'customize_selective_refresh' => true,
49	)
50	);
51	add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
52
53	$this->default_title = esc_html__( 'Translate', 'jetpack' );
54	}
55
56	/**
57	* Enqueue frontend JS scripts.
58	*/
59	public function enqueue_scripts() {
60	wp_register_script(
61	'google-translate-init',
62	Assets::get_file_url_for_environment(
63	'_inc/build/widgets/google-translate/google-translate.min.js',
64	'modules/widgets/google-translate/google-translate.js'
65	),
66	array(),
67	JETPACK__VERSION,
68	false
69	);
70	wp_register_script(
71	'google-translate',
72	'//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit',
73	array( 'google-translate-init' ),
74	JETPACK__VERSION,
75	false
76	);
77	// Admin bar is also displayed on top of the site which causes google translate bar to hide beneath.
78	// Overwrite position of body.admin-bar
79	// This is a hack to show google translate bar a bit lower.
80	$lower_translate_bar = '
81	.admin-bar {
82	position: inherit !important;
83	top: auto !important;
84	}
85	.admin-bar .goog-te-banner-frame {
86	top: 32px !important
87	}
88	@media screen and (max-width: 782px) {
89	.admin-bar .goog-te-banner-frame {
90	top: 46px !important;
91	}
92	}
93	@media screen and (max-width: 480px) {
94	.admin-bar .goog-te-banner-frame {
95	position: absolute;
96	}
97	}
98	';
99	wp_add_inline_style( 'admin-bar', $lower_translate_bar );
100	wp_add_inline_style( 'wpcom-admin-bar', $lower_translate_bar );
101	}
102
103	/**
104	* Display the Widget.
105	*
106	* @see WP_Widget::widget()
107	*
108	* @param array $args Display arguments.
109	* @param array $instance The settings for the particular instance of the widget.
110	*/
111	public function widget( $args, $instance ) {
112	// We never should show more than 1 instance of this.
113	if ( null === self::$instance ) {
114	$instance = wp_parse_args(
115	$instance,
116	array(
117	'title' => $this->default_title,
118	)
119	);
120
121	/**
122	* Filter the layout of the Google Translate Widget.
123	*
124	* 3 different integers are accepted.
125	* 0 for the vertical layout.
126	* 1 for the horizontal layout.
127	* 2 for the dropdown only.
128	*
129	* @see https://translate.google.com/manager/website/
130	*
131	* @module widgets
132	*
133	* @since 5.5.0
134	*
135	* @param string $layout layout of the Google Translate Widget.
136	*/
137	$button_layout = apply_filters( 'jetpack_google_translate_widget_layout', 0 );
138
139	if (
140	! is_int( $button_layout )
141	\|\| 0 > $button_layout
142	\|\| 2 < $button_layout
143	) {
144	$button_layout = 0;
145	}
146
147	wp_localize_script(
148	'google-translate-init',
149	'_wp_google_translate_widget',
150	array(
151	'lang' => get_locale(),
152	'layout' => $button_layout,
153	)
154	);
155	wp_enqueue_script( 'google-translate-init' );
156	wp_enqueue_script( 'google-translate' );
157
158	$title = $instance['title'];
159
160	if ( ! isset( $title ) ) {
161	$title = $this->default_title;
162	}
163
164	/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
165	$title = apply_filters( 'widget_title', $title );
166
167	echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
168	if ( ! empty( $title ) ) {
169	echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
170	}
171	echo '<div id="google_translate_element"></div>';
172	echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
173	self::$instance = $instance;
174	/** This action is documented in modules/widgets/gravatar-profile.php */
175	do_action( 'jetpack_stats_extra', 'widget_view', 'google-translate' );
176	}
177	}
178
179	/**
180	* Widget form in the dashboard.
181	*
182	* @see WP_Widget::form()
183	*
184	* @param array $instance Previously saved values from database.
185	* @return string\|void
186	*/
187	public function form( $instance ) {
188	$title = $instance['title'] ?? false;
189	if ( false === $title ) {
190	$title = $this->default_title;
191	}
192	?>
193	<p>
194	<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label>
195	<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" />
196	</p>
197	<?php
198	}
199
200	/**
201	* Sanitize widget form values as they are saved.
202	*
203	* @see WP_Widget::update()
204	*
205	* @param array $new_instance Values just sent to be saved.
206	* @param array $old_instance Previously saved values from database.
207	*
208	* @return array $instance Updated safe values to be saved.
209	*/
210	public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
211	$instance = array();
212	$instance['title'] = wp_kses( $new_instance['title'], array() );
213	if ( $instance['title'] === $this->default_title ) {
214	$instance['title'] = false; // Store as false in case of language change.
215	}
216	return $instance;
217	}
218	}
219
220	/**
221	* Register the widget for use in Appearance -> Widgets.
222	*/
223	function jetpack_google_translate_widget_init() {
224	register_widget( 'Jetpack_Google_Translate_Widget' );
225	}
226	add_action( 'widgets_init', 'jetpack_google_translate_widget_init' );
227