functions.global.php — Jetpack – WP Security, Backup, Speed, & Growth 7.2.1

jetpack / functions.global.php

jetpack Last commit date

functions.global.php

209 lines

1	<?php
2	/**
3	* This file is meant to be the home for any generic & reusable functions
4	* that can be accessed anywhere within Jetpack.
5	*
6	* This file is loaded whether or not Jetpack is active.
7	*
8	* Please namespace with jetpack_
9	* Please write docblocks
10	*/
11
12	/**
13	* Disable direct access.
14	*/
15	if ( ! defined( 'ABSPATH' ) ) {
16	exit;
17	}
18
19	/**
20	* Set the admin language, based on user language.
21	*
22	* @since 4.5.0
23	* @deprecated 6.6.0 Use Core function instead.
24	*
25	* @return string
26	*/
27	function jetpack_get_user_locale() {
28	_deprecated_function( __FUNCTION__, 'jetpack-6.6.0', 'get_user_locale' );
29	return get_user_locale();
30	}
31
32	/**
33	* Determine if this site is an Atomic site or not looking first at the 'at_options' option.
34	* As a fallback, check for presence of wpcomsh plugin to determine if a current site has undergone AT.
35	*
36	* @since 4.8.1
37	*
38	* @return bool
39	*/
40	function jetpack_is_atomic_site() {
41	$at_options = get_option( 'at_options', array() );
42	return ! empty( $at_options ) \|\| defined( 'WPCOMSH__PLUGIN_FILE' );
43	}
44
45	/**
46	* Register post type for migration.
47	*
48	* @since 5.2
49	*/
50	function jetpack_register_migration_post_type() {
51	register_post_type( 'jetpack_migration', array(
52	'supports' => array(),
53	'taxonomies' => array(),
54	'hierarchical' => false,
55	'public' => false,
56	'has_archive' => false,
57	'can_export' => true,
58	) );
59	}
60
61	/**
62	* Stores migration data in the database.
63	*
64	* @since 5.2
65	*
66	* @param string $option_name
67	* @param bool $option_value
68	*
69	* @return int\|WP_Error
70	*/
71	function jetpack_store_migration_data( $option_name, $option_value ) {
72	jetpack_register_migration_post_type();
73
74	$insert = array(
75	'post_title' => $option_name,
76	'post_content_filtered' => $option_value,
77	'post_type' => 'jetpack_migration',
78	'post_date' => date( 'Y-m-d H:i:s', time() ),
79	);
80
81	$post = get_page_by_title( $option_name, 'OBJECT', 'jetpack_migration' );
82
83	if ( null !== $post ) {
84	$insert['ID'] = $post->ID;
85	}
86
87	return wp_insert_post( $insert, true );
88	}
89
90	/**
91	* Retrieves legacy image widget data.
92	*
93	* @since 5.2
94	*
95	* @param string $option_name
96	*
97	* @return mixed\|null
98	*/
99	function jetpack_get_migration_data( $option_name ) {
100	$post = get_page_by_title( $option_name, 'OBJECT', 'jetpack_migration' );
101
102	return null !== $post ? maybe_unserialize( $post->post_content_filtered ) : null;
103	}
104
105	/**
106	* Prints a TOS blurb used throughout the connection prompts.
107	*
108	* @since 5.3
109	*
110	* @return string
111	*/
112	function jetpack_render_tos_blurb() {
113	printf(
114	__( 'By clicking the <strong>Set up Jetpack</strong> button, you agree to our <a href="%s" target="_blank">Terms of Service</a> and to <a href="%s" target="_blank">share details</a> with WordPress.com.', 'jetpack' ),
115	'https://wordpress.com/tos',
116	'https://jetpack.com/support/what-data-does-jetpack-sync'
117	);
118	}
119
120	/**
121	* Intervene upgrade process so Jetpack themes are downloaded with credentials.
122	*
123	* @since 5.3
124	*
125	* @param bool $preempt Whether to preempt an HTTP request's return value. Default false.
126	* @param array $r HTTP request arguments.
127	* @param string $url The request URL.
128	*
129	* @return array\|bool\|WP_Error
130	*/
131	function jetpack_theme_update( $preempt, $r, $url ) {
132	if ( false !== stripos( $url, JETPACK__WPCOM_JSON_API_HOST . '/rest/v1/themes/download' ) ) {
133	$file = $r['filename'];
134	if ( ! $file ) {
135	return new WP_Error( 'problem_creating_theme_file', esc_html__( 'Problem creating file for theme download', 'jetpack' ) );
136	}
137	$theme = pathinfo( parse_url( $url, PHP_URL_PATH ), PATHINFO_FILENAME );
138
139	// Remove filter to avoid endless loop since wpcom_json_api_request_as_blog uses this too.
140	remove_filter( 'pre_http_request', 'jetpack_theme_update' );
141	$result = Jetpack_Client::wpcom_json_api_request_as_blog(
142	"themes/download/$theme.zip", '1.1', array( 'stream' => true, 'filename' => $file )
143	);
144
145	if ( 200 !== wp_remote_retrieve_response_code( $result ) ) {
146	return new WP_Error( 'problem_fetching_theme', esc_html__( 'Problem downloading theme', 'jetpack' ) );
147	}
148	return $result;
149	}
150	return $preempt;
151	}
152
153	/**
154	* Add the filter when a upgrade is going to be downloaded.
155	*
156	* @since 5.3
157	*
158	* @param bool $reply Whether to bail without returning the package. Default false.
159	*
160	* @return bool
161	*/
162	function jetpack_upgrader_pre_download( $reply ) {
163	add_filter( 'pre_http_request', 'jetpack_theme_update', 10, 3 );
164	return $reply;
165	}
166
167	add_filter( 'upgrader_pre_download', 'jetpack_upgrader_pre_download' );
168
169
170	/**
171	* Wraps data in a way so that we can distinguish between objects and array and also prevent object recursion.
172	*
173	* @since 6.1.0
174	*
175	* @param $any
176	* @param array $seen_nodes
177	*
178	* @return array
179	*/
180	function jetpack_json_wrap( &$any, $seen_nodes = array() ) {
181	if ( is_object( $any ) ) {
182	$input = get_object_vars( $any );
183	$input['__o'] = 1;
184	} else {
185	$input = &$any;
186	}
187
188	if ( is_array( $input ) ) {
189	$seen_nodes[] = &$any;
190
191	$return = array();
192
193	foreach ( $input as $k => &$v ) {
194	if ( ( is_array( $v ) \|\| is_object( $v ) ) ) {
195	if ( in_array( $v, $seen_nodes, true ) ) {
196	continue;
197	}
198	$return[ $k ] = jetpack_json_wrap( $v, $seen_nodes );
199	} else {
200	$return[ $k ] = $v;
201	}
202	}
203
204	return $return;
205	}
206
207	return $any;
208	}
209