Functions::get_shortcodes() - Code Metrics - Inspection of "Update class-functions" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/add-managed-wp-hosts ( 1b6daa )

unknown

created 2019-12-12 02:04 UTC

Functions::get_shortcodes() A

↳ Parent: Functions

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Utility functions to generate data synced to wpcom
 *
 * @package automattic/jetpack-sync
 */

namespace Automattic\Jetpack\Sync;

use Automattic\Jetpack\Constants;

/**
 * Utility functions to generate data synced to wpcom
 */
class Functions {
	const HTTPS_CHECK_OPTION_PREFIX = 'jetpack_sync_https_history_';
	const HTTPS_CHECK_HISTORY       = 5;

	/**
	 * Return array of Jetpack modules.
	 *
	 * @return array
	 */
	public static function get_modules() {
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';

		return \Jetpack_Admin::init()->get_modules();
	}

	/**
	 * Return array of taxonomies registered on the site.
	 *
	 * @return array
	 */
	public static function get_taxonomies() {
		global $wp_taxonomies;
		$wp_taxonomies_without_callbacks = array();
		foreach ( $wp_taxonomies as $taxonomy_name => $taxonomy ) {
			$sanitized_taxonomy = self::sanitize_taxonomy( $taxonomy );
			if ( ! empty( $sanitized_taxonomy ) ) {
				$wp_taxonomies_without_callbacks[ $taxonomy_name ] = $sanitized_taxonomy;
			}
		}
		return $wp_taxonomies_without_callbacks;
	}

	/**
	 * Return array of registered shortcodes.
	 *
	 * @return array
	 */
	public static function get_shortcodes() {
		global $shortcode_tags;
		return array_keys( $shortcode_tags );
	}

	/**
	 * Removes any callback data since we will not be able to process it on our side anyways.
	 *
	 * @param \WP_Taxonomy $taxonomy \WP_Taxonomy item.
	 *
	 * @return mixed|null
	 */
	public static function sanitize_taxonomy( $taxonomy ) {

		// Lets clone the taxonomy object instead of modifing the global one.
		$cloned_taxonomy = json_decode( wp_json_encode( $taxonomy ) );

		// recursive taxonomies are no fun.
		if ( is_null( $cloned_taxonomy ) ) {
			return null;
		}
		// Remove any meta_box_cb if they are not the default wp ones.
		if ( isset( $cloned_taxonomy->meta_box_cb ) &&
			! in_array( $cloned_taxonomy->meta_box_cb, array( 'post_tags_meta_box', 'post_categories_meta_box' ), true ) ) {
			$cloned_taxonomy->meta_box_cb = null;
		}
		// Remove update call back.
		if ( isset( $cloned_taxonomy->update_count_callback ) &&
			! is_null( $cloned_taxonomy->update_count_callback ) ) {
			$cloned_taxonomy->update_count_callback = null;
		}
		// Remove rest_controller_class if it something other then the default.
		if ( isset( $cloned_taxonomy->rest_controller_class ) &&
			'WP_REST_Terms_Controller' !== $cloned_taxonomy->rest_controller_class ) {
			$cloned_taxonomy->rest_controller_class = null;
		}
		return $cloned_taxonomy;
	}

	/**
	 * Return array of registered post types.
	 *
	 * @return array
	 */
	public static function get_post_types() {
		global $wp_post_types;

		$post_types_without_callbacks = array();
		foreach ( $wp_post_types as $post_type_name => $post_type ) {
			$sanitized_post_type = self::sanitize_post_type( $post_type );
			if ( ! empty( $sanitized_post_type ) ) {
				$post_types_without_callbacks[ $post_type_name ] = $sanitized_post_type;
			}
		}
		return $post_types_without_callbacks;
	}

	/**
	 * Sanitizes by cloning post type object.
	 *
	 * @param object $post_type \WP_Post_Type.
	 *
	 * @return object
	 */
	public static function sanitize_post_type( $post_type ) {
		// Lets clone the post type object instead of modifing the global one.
		$sanitized_post_type = array();
		foreach ( Defaults::$default_post_type_attributes as $attribute_key => $default_value ) {
			if ( isset( $post_type->{ $attribute_key } ) ) {
				$sanitized_post_type[ $attribute_key ] = $post_type->{ $attribute_key };
			}
		}
		return (object) $sanitized_post_type;
	}

	/**
	 * Return information about a synced post type.
	 *
	 * @param array  $sanitized_post_type Array of args used in constructing \WP_Post_Type.
	 * @param string $post_type Post type name.
	 *
	 * @return object \WP_Post_Type
	 */
	public static function expand_synced_post_type( $sanitized_post_type, $post_type ) {
		$post_type        = sanitize_key( $post_type );
		$post_type_object = new \WP_Post_Type( $post_type, $sanitized_post_type );
		$post_type_object->add_supports();
		$post_type_object->add_rewrite_rules();
		$post_type_object->add_hooks();
		$post_type_object->register_taxonomies();
		return (object) $post_type_object;
	}

	/**
	 * Returns site's post_type_features.
	 *
	 * @return array
	 */
	public static function get_post_type_features() {
		global $_wp_post_type_features;

		return $_wp_post_type_features;
	}

	/**
	 * Return hosting provider.
	 *
	 * Uses a set of known constants, classes, or functions to help determine the hosting platform.
	 *
	 * @return string Hosting provider.
	 */
	public static function get_hosting_provider() {
		if ( defined( 'GD_SYSTEM_PLUGIN_DIR' ) || class_exists( '\\WPaaS\\Plugin' ) ) {
			return 'gd-managed-wp';
		}
		if ( defined( 'MM_BASE_DIR' ) ) {
			return 'bh';
		}
		if ( defined( 'PAGELYBIN' ) ) {
			return 'pagely';
		}
		if ( defined( 'KINSTAMU_VERSION' ) ) {
			return 'kinsta';
		}
		if ( defined( 'FLYWHEEL_CONFIG_DIR' ) ) {
			return 'flywheel';
		}
		if ( defined( 'IS_PRESSABLE' ) ) {
			return 'pressable';
		}
		if ( function_exists( 'is_wpe' ) || function_exists( 'is_wpe_snapshot' ) ) {
			return 'wpe';
		}
		if ( defined( 'VIP_GO_ENV' ) && false !== VIP_GO_ENV ) {
			return 'vip-go';
		}
		return 'unknown';
	}

	/**
	 * Return array of allowed REST API post types.
	 *
	 * @return array Array of allowed post types.
	 */
	public static function rest_api_allowed_post_types() {
		/** This filter is already documented in class.json-api-endpoints.php */
		return apply_filters( 'rest_api_allowed_post_types', array( 'post', 'page', 'revision' ) );
	}

	/**
	 * Return array of allowed REST API public metadata.
	 *
	 * @return array Array of allowed metadata.
	 */
	public static function rest_api_allowed_public_metadata() {
		/** This filter is documented in json-endpoints/class.wpcom-json-api-post-endpoint.php */
		return apply_filters( 'rest_api_allowed_public_metadata', array() );
	}

	/**
	 * Finds out if a site is using a version control system.
	 *
	 * @return bool
	 **/
	public static function is_version_controlled() {

		if ( ! class_exists( 'WP_Automatic_Updater' ) ) {
			require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
		}
		$updater = new \WP_Automatic_Updater();

		return (bool) strval( $updater->is_vcs_checkout( ABSPATH ) );
	}

	/**
	 * Returns true if the site has file write access false otherwise.
	 *
	 * @return bool
	 **/
	public static function file_system_write_access() {
		if ( ! function_exists( 'get_filesystem_method' ) ) {
			require_once ABSPATH . 'wp-admin/includes/file.php';
		}

		require_once ABSPATH . 'wp-admin/includes/template.php';

		$filesystem_method = get_filesystem_method();
		if ( 'direct' === $filesystem_method ) {
			return true;
		}

		ob_start();

		if ( ! function_exists( 'request_filesystem_credentials' ) ) {
			require_once ABSPATH . 'wp-admin/includes/file.php';
		}

		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
		ob_end_clean();
		if ( $filesystem_credentials_are_stored ) {
			return true;
		}

		return false;
	}

	/**
	 * Helper function that is used when getting home or siteurl values. Decides
	 * whether to get the raw or filtered value.
	 *
	 * @param string $url_type URL to get, home or siteurl.
	 * @return string
	 */
	public static function get_raw_or_filtered_url( $url_type ) {
		$url_function = ( 'home' === $url_type )
			? 'home_url'
			: 'site_url';

		if (
			! Constants::is_defined( 'JETPACK_SYNC_USE_RAW_URL' ) ||
			Constants::get_constant( 'JETPACK_SYNC_USE_RAW_URL' )
		) {
			$scheme = is_ssl() ? 'https' : 'http';
			$url    = self::get_raw_url( $url_type );
			$url    = set_url_scheme( $url, $scheme );
		} else {
			$url = self::normalize_www_in_url( $url_type, $url_function );
		}

		return self::get_protocol_normalized_url( $url_function, $url );
	}

	/**
	 * Return the escaped home_url.
	 *
	 * @return string
	 */
	public static function home_url() {
		$url = self::get_raw_or_filtered_url( 'home' );

		/**
		 * Allows overriding of the home_url value that is synced back to WordPress.com.
		 *
		 * @since 5.2.0
		 *
		 * @param string $home_url
		 */
		return esc_url_raw( apply_filters( 'jetpack_sync_home_url', $url ) );
	}

	/**
	 * Return the escaped siteurl.
	 *
	 * @return string
	 */
	public static function site_url() {
		$url = self::get_raw_or_filtered_url( 'siteurl' );

		/**
		 * Allows overriding of the site_url value that is synced back to WordPress.com.
		 *
		 * @since 5.2.0
		 *
		 * @param string $site_url
		 */
		return esc_url_raw( apply_filters( 'jetpack_sync_site_url', $url ) );
	}

	/**
	 * Return main site URL with a normalized protocol.
	 *
	 * @return string
	 */
	public static function main_network_site_url() {
		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
	}

	/**
	 * Return URL with a normalized protocol.
	 *
	 * @param callable $callable Function to retrieve URL option.
	 * @param string   $new_value URL Protocol to set URLs to.
	 * @return string Normalized URL.
	 */
	public static function get_protocol_normalized_url( $callable, $new_value ) {
		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;

		$parsed_url = wp_parse_url( $new_value );
		if ( ! $parsed_url ) {
			return $new_value;
		}
		if ( array_key_exists( 'scheme', $parsed_url ) ) {
			$scheme = $parsed_url['scheme'];
		} else {
			$scheme = '';
		}
		$scheme_history   = get_option( $option_key, array() );
		$scheme_history[] = $scheme;

		// Limit length to self::HTTPS_CHECK_HISTORY.
		$scheme_history = array_slice( $scheme_history, ( self::HTTPS_CHECK_HISTORY * -1 ) );

		update_option( $option_key, $scheme_history );

		$forced_scheme = in_array( 'https', $scheme_history, true ) ? 'https' : 'http';

		return set_url_scheme( $new_value, $forced_scheme );
	}

	/**
	 * Return URL from option or PHP constant.
	 *
	 * @param string $option_name (e.g. 'home').
	 *
	 * @return mixed|null URL.
	 */
	public static function get_raw_url( $option_name ) {
		$value    = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$constant = ( 'home' === $option_name )
			? 'WP_HOME'
			: 'WP_SITEURL';

		// Since we disregard the constant for multisites in ms-default-filters.php,
		// let's also use the db value if this is a multisite.
		if ( ! is_multisite() && Constants::is_defined( $constant ) ) {
			$value = Constants::get_constant( $constant );
		} else {
			// Let's get the option from the database so that we can bypass filters. This will help
			// ensure that we get more uniform values.
			$value = \Jetpack_Options::get_raw_option( $option_name );
		}

		return $value;
	}

	/**
	 * Normalize domains by removing www unless declared in the site's option.
	 *
	 * @param string   $option Option value from the site.
	 * @param callable $url_function Function retrieving the URL to normalize.
	 * @return mixed|string URL.
	 */
	public static function normalize_www_in_url( $option, $url_function ) {
		$url        = wp_parse_url( call_user_func( $url_function ) );
		$option_url = wp_parse_url( get_option( $option ) );

		if ( ! $option_url || ! $url ) {
			return $url;
		}

		if ( "www.{$option_url[ 'host' ]}" === $url['host'] ) {
			// remove www if not present in option URL.
			$url['host'] = $option_url['host'];
		}
		if ( "www.{$url[ 'host' ]}" === $option_url['host'] ) {
			// add www if present in option URL.
			$url['host'] = $option_url['host'];
		}

		$normalized_url = "{$url['scheme']}://{$url['host']}";
		if ( isset( $url['path'] ) ) {
			$normalized_url .= "{$url['path']}";
		}

		if ( isset( $url['query'] ) ) {
			$normalized_url .= "?{$url['query']}";
		}

		return $normalized_url;
	}

	/**
	 * Return filtered value of get_plugins.
	 *
	 * @return mixed|void
	 */
	public static function get_plugins() {
		if ( ! function_exists( 'get_plugins' ) ) {
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
		}

		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
		return apply_filters( 'all_plugins', get_plugins() );
	}

	/**
	 * Get custom action link tags that the plugin is using
	 * Ref: https://codex.wordpress.org/Plugin_API/Filter_Reference/plugin_action_links_(plugin_file_name)
	 *
	 * @param string $plugin_file_singular Particular plugin.

	 * @return array of plugin action links (key: link name value: url)
	 */
	public static function get_plugins_action_links( $plugin_file_singular = null ) {
		// Some sites may have DOM disabled in PHP fail early.
		if ( ! class_exists( 'DOMDocument' ) ) {
			return array();
		}
		$plugins_action_links = get_option( 'jetpack_plugin_api_action_links', array() );
		if ( ! empty( $plugins_action_links ) ) {
			if ( is_null( $plugin_file_singular ) ) {
				return $plugins_action_links;
			}
			return ( isset( $plugins_action_links[ $plugin_file_singular ] ) ? $plugins_action_links[ $plugin_file_singular ] : null );
		}
		return array();
	}

	/**
	 * Return the WP version as defined in the $wp_version global.
	 *
	 * @return string
	 */
	public static function wp_version() {
		global $wp_version;
		return $wp_version;
	}

	/**
	 * Return site icon url used on the site.
	 *
	 * @param int $size Size of requested icon in pixels.
	 * @return mixed|string|void
	 */
	public static function site_icon_url( $size = 512 ) {
		$site_icon = get_site_icon_url( $size );
		return $site_icon ? $site_icon : get_option( 'jetpack_site_icon_url' );
	}

	/**
	 * Return roles registered on the site.
	 *
	 * @return array
	 */
	public static function roles() {
		$wp_roles = wp_roles();
		return $wp_roles->roles;
	}

	/**
	 * Determine time zone from WordPress' options "timezone_string"
	 * and "gmt_offset".
	 *
	 * 1. Check if `timezone_string` is set and return it.
	 * 2. Check if `gmt_offset` is set, formats UTC-offset from it and return it.
	 * 3. Default to "UTC+0" if nothing is set.
	 *
	 * Note: This function is specifically not using wp_timezone() to keep consistency with
	 * the existing formatting of the timezone string.
	 *
	 * @return string
	 */
	public static function get_timezone() {
		$timezone_string = get_option( 'timezone_string' );

		if ( ! empty( $timezone_string ) ) {
			return str_replace( '_', ' ', $timezone_string );
		}

		$gmt_offset = get_option( 'gmt_offset', 0 );

		$formatted_gmt_offset = sprintf( '%+g', floatval( $gmt_offset ) );

		$formatted_gmt_offset = str_replace(
			array( '.25', '.5', '.75' ),
			array( ':15', ':30', ':45' ),
			(string) $formatted_gmt_offset
		);

		/* translators: %s is UTC offset, e.g. "+1" */
		return sprintf( __( 'UTC%s', 'jetpack' ), $formatted_gmt_offset );
	}

	/**
	 * Return list of paused themes.
	 *
	 * @todo Remove function_exists check when WP 5.2 is the minimum.
	 *
	 * @return array|bool Array of paused themes or false if unsupported.
	 */
	public static function get_paused_themes() {
		if ( function_exists( 'wp_paused_themes' ) ) {
			$paused_themes = wp_paused_themes();
			return $paused_themes->get_all();
		}
		return false;
	}

	/**
	 * Return list of paused plugins.
	 *
	 * @todo Remove function_exists check when WP 5.2 is the minimum.
	 *
	 * @return array|bool Array of paused plugins or false if unsupported.
	 */
	public static function get_paused_plugins() {
		if ( function_exists( 'wp_paused_plugins' ) ) {
			$paused_plugins = wp_paused_plugins();
			return $paused_plugins->get_all();
		}
		return false;
	}
}


1		<?php
2		/**
3		* Utility functions to generate data synced to wpcom
4		*
5		* @package automattic/jetpack-sync
6		*/
7
8		namespace Automattic\Jetpack\Sync;
9
10		use Automattic\Jetpack\Constants;
11
12		/**
13		* Utility functions to generate data synced to wpcom
14		*/
15		class Functions {
16		const HTTPS_CHECK_OPTION_PREFIX = 'jetpack_sync_https_history_';
17		const HTTPS_CHECK_HISTORY = 5;
18
19		/**
20		* Return array of Jetpack modules.
21		*
22		* @return array
23		*/
24		public static function get_modules() {
25		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
26
27		return \Jetpack_Admin::init()->get_modules();
28		}
29
30		/**
31		* Return array of taxonomies registered on the site.
32		*
33		* @return array
34		*/
35		public static function get_taxonomies() {
36		global $wp_taxonomies;
37		$wp_taxonomies_without_callbacks = array();
38		foreach ( $wp_taxonomies as $taxonomy_name => $taxonomy ) {
39		$sanitized_taxonomy = self::sanitize_taxonomy( $taxonomy );
40		if ( ! empty( $sanitized_taxonomy ) ) {
41		$wp_taxonomies_without_callbacks[ $taxonomy_name ] = $sanitized_taxonomy;
42		}
43		}
44		return $wp_taxonomies_without_callbacks;
45		}
46
47		/**
48		* Return array of registered shortcodes.
49		*
50		* @return array
51		*/
52		public static function get_shortcodes() {
53		global $shortcode_tags;
54		return array_keys( $shortcode_tags );
55		}
56
57		/**
58		* Removes any callback data since we will not be able to process it on our side anyways.
59		*
60		* @param \WP_Taxonomy $taxonomy \WP_Taxonomy item.
61		*
62		* @return mixed\|null
63		*/
64		public static function sanitize_taxonomy( $taxonomy ) {
65
66		// Lets clone the taxonomy object instead of modifing the global one.
67		$cloned_taxonomy = json_decode( wp_json_encode( $taxonomy ) );
68
69		// recursive taxonomies are no fun.
70		if ( is_null( $cloned_taxonomy ) ) {
71		return null;
72		}
73		// Remove any meta_box_cb if they are not the default wp ones.
74		if ( isset( $cloned_taxonomy->meta_box_cb ) &&
75		! in_array( $cloned_taxonomy->meta_box_cb, array( 'post_tags_meta_box', 'post_categories_meta_box' ), true ) ) {
76		$cloned_taxonomy->meta_box_cb = null;
77		}
78		// Remove update call back.
79		if ( isset( $cloned_taxonomy->update_count_callback ) &&
80		! is_null( $cloned_taxonomy->update_count_callback ) ) {
81		$cloned_taxonomy->update_count_callback = null;
82		}
83		// Remove rest_controller_class if it something other then the default.
84		if ( isset( $cloned_taxonomy->rest_controller_class ) &&
85		'WP_REST_Terms_Controller' !== $cloned_taxonomy->rest_controller_class ) {
86		$cloned_taxonomy->rest_controller_class = null;
87		}
88		return $cloned_taxonomy;
89		}
90
91		/**
92		* Return array of registered post types.
93		*
94		* @return array
95		*/
96		public static function get_post_types() {
97		global $wp_post_types;
98
99		$post_types_without_callbacks = array();
100		foreach ( $wp_post_types as $post_type_name => $post_type ) {
101		$sanitized_post_type = self::sanitize_post_type( $post_type );
102		if ( ! empty( $sanitized_post_type ) ) {
103		$post_types_without_callbacks[ $post_type_name ] = $sanitized_post_type;
104		}
105		}
106		return $post_types_without_callbacks;
107		}
108
109		/**
110		* Sanitizes by cloning post type object.
111		*
112		* @param object $post_type \WP_Post_Type.
113		*
114		* @return object
115		*/
116		public static function sanitize_post_type( $post_type ) {
117		// Lets clone the post type object instead of modifing the global one.
118		$sanitized_post_type = array();
119		foreach ( Defaults::$default_post_type_attributes as $attribute_key => $default_value ) {
120		if ( isset( $post_type->{ $attribute_key } ) ) {
121		$sanitized_post_type[ $attribute_key ] = $post_type->{ $attribute_key };
122		}
123		}
124		return (object) $sanitized_post_type;
125		}
126
127		/**
128		* Return information about a synced post type.
129		*
130		* @param array $sanitized_post_type Array of args used in constructing \WP_Post_Type.
131		* @param string $post_type Post type name.
132		*
133		* @return object \WP_Post_Type
134		*/
135		public static function expand_synced_post_type( $sanitized_post_type, $post_type ) {
136		$post_type = sanitize_key( $post_type );
137		$post_type_object = new \WP_Post_Type( $post_type, $sanitized_post_type );
138		$post_type_object->add_supports();
139		$post_type_object->add_rewrite_rules();
140		$post_type_object->add_hooks();
141		$post_type_object->register_taxonomies();
142		return (object) $post_type_object;
143		}
144
145		/**
146		* Returns site's post_type_features.
147		*
148		* @return array
149		*/
150		public static function get_post_type_features() {
151		global $_wp_post_type_features;
152
153		return $_wp_post_type_features;
154		}
155
156		/**
157		* Return hosting provider.
158		*
159		* Uses a set of known constants, classes, or functions to help determine the hosting platform.
160		*
161		* @return string Hosting provider.
162		*/
163		public static function get_hosting_provider() {
164		if ( defined( 'GD_SYSTEM_PLUGIN_DIR' ) \|\| class_exists( '\\WPaaS\\Plugin' ) ) {
165		return 'gd-managed-wp';
166		}
167		if ( defined( 'MM_BASE_DIR' ) ) {
168		return 'bh';
169		}
170		if ( defined( 'PAGELYBIN' ) ) {
171		return 'pagely';
172		}
173		if ( defined( 'KINSTAMU_VERSION' ) ) {
174		return 'kinsta';
175		}
176		if ( defined( 'FLYWHEEL_CONFIG_DIR' ) ) {
177		return 'flywheel';
178		}
179		if ( defined( 'IS_PRESSABLE' ) ) {
180		return 'pressable';
181		}
182		if ( function_exists( 'is_wpe' ) \|\| function_exists( 'is_wpe_snapshot' ) ) {
183		return 'wpe';
184		}
185		if ( defined( 'VIP_GO_ENV' ) && false !== VIP_GO_ENV ) {
186		return 'vip-go';
187		}
188		return 'unknown';
189		}
190
191		/**
192		* Return array of allowed REST API post types.
193		*
194		* @return array Array of allowed post types.
195		*/
196		public static function rest_api_allowed_post_types() {
197		/** This filter is already documented in class.json-api-endpoints.php */
198		return apply_filters( 'rest_api_allowed_post_types', array( 'post', 'page', 'revision' ) );
199		}
200
201		/**
202		* Return array of allowed REST API public metadata.
203		*
204		* @return array Array of allowed metadata.
205		*/
206		public static function rest_api_allowed_public_metadata() {
207		/** This filter is documented in json-endpoints/class.wpcom-json-api-post-endpoint.php */
208		return apply_filters( 'rest_api_allowed_public_metadata', array() );
209		}
210
211		/**
212		* Finds out if a site is using a version control system.
213		*
214		* @return bool
215		**/
216		public static function is_version_controlled() {
217
218		if ( ! class_exists( 'WP_Automatic_Updater' ) ) {
219		require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
220		}
221		$updater = new \WP_Automatic_Updater();
222
223		return (bool) strval( $updater->is_vcs_checkout( ABSPATH ) );
224		}
225
226		/**
227		* Returns true if the site has file write access false otherwise.
228		*
229		* @return bool
230		**/
231		public static function file_system_write_access() {
232		if ( ! function_exists( 'get_filesystem_method' ) ) {
233		require_once ABSPATH . 'wp-admin/includes/file.php';
234		}
235
236		require_once ABSPATH . 'wp-admin/includes/template.php';
237
238		$filesystem_method = get_filesystem_method();
239		if ( 'direct' === $filesystem_method ) {
240		return true;
241		}
242
243		ob_start();
244
245		if ( ! function_exists( 'request_filesystem_credentials' ) ) {
246		require_once ABSPATH . 'wp-admin/includes/file.php';
247		}
248
249		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
250		ob_end_clean();
251		if ( $filesystem_credentials_are_stored ) {
252		return true;
253		}
254
255		return false;
256		}
257
258		/**
259		* Helper function that is used when getting home or siteurl values. Decides
260		* whether to get the raw or filtered value.
261		*
262		* @param string $url_type URL to get, home or siteurl.
263		* @return string
264		*/
265		public static function get_raw_or_filtered_url( $url_type ) {
266		$url_function = ( 'home' === $url_type )
267		? 'home_url'
268		: 'site_url';
269
270		if (
271		! Constants::is_defined( 'JETPACK_SYNC_USE_RAW_URL' ) \|\|
272		Constants::get_constant( 'JETPACK_SYNC_USE_RAW_URL' )
273		) {
274		$scheme = is_ssl() ? 'https' : 'http';
275		$url = self::get_raw_url( $url_type );
276		$url = set_url_scheme( $url, $scheme );
277		} else {
278		$url = self::normalize_www_in_url( $url_type, $url_function );
279		}
280
281		return self::get_protocol_normalized_url( $url_function, $url );
282		}
283
284		/**
285		* Return the escaped home_url.
286		*
287		* @return string
288		*/
289		public static function home_url() {
290		$url = self::get_raw_or_filtered_url( 'home' );
291
292		/**
293		* Allows overriding of the home_url value that is synced back to WordPress.com.
294		*
295		* @since 5.2.0
296		*
297		* @param string $home_url
298		*/
299		return esc_url_raw( apply_filters( 'jetpack_sync_home_url', $url ) );
300		}
301
302		/**
303		* Return the escaped siteurl.
304		*
305		* @return string
306		*/
307		public static function site_url() {
308		$url = self::get_raw_or_filtered_url( 'siteurl' );
309
310		/**
311		* Allows overriding of the site_url value that is synced back to WordPress.com.
312		*
313		* @since 5.2.0
314		*
315		* @param string $site_url
316		*/
317		return esc_url_raw( apply_filters( 'jetpack_sync_site_url', $url ) );
318		}
319
320		/**
321		* Return main site URL with a normalized protocol.
322		*
323		* @return string
324		*/
325		public static function main_network_site_url() {
326		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
327		}
328
329		/**
330		* Return URL with a normalized protocol.
331		*
332		* @param callable $callable Function to retrieve URL option.
333		* @param string $new_value URL Protocol to set URLs to.
334		* @return string Normalized URL.
335		*/
336		public static function get_protocol_normalized_url( $callable, $new_value ) {
337		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
338
339		$parsed_url = wp_parse_url( $new_value );
340		if ( ! $parsed_url ) {
341		return $new_value;
342		}
343		if ( array_key_exists( 'scheme', $parsed_url ) ) {
344		$scheme = $parsed_url['scheme'];
345		} else {
346		$scheme = '';
347		}
348		$scheme_history = get_option( $option_key, array() );
349		$scheme_history[] = $scheme;
350
351		// Limit length to self::HTTPS_CHECK_HISTORY.
352		$scheme_history = array_slice( $scheme_history, ( self::HTTPS_CHECK_HISTORY * -1 ) );
353
354		update_option( $option_key, $scheme_history );
355
356		$forced_scheme = in_array( 'https', $scheme_history, true ) ? 'https' : 'http';
357
358		return set_url_scheme( $new_value, $forced_scheme );
359		}
360
361		/**
362		* Return URL from option or PHP constant.
363		*
364		* @param string $option_name (e.g. 'home').
365		*
366		* @return mixed\|null URL.
367		*/
368		public static function get_raw_url( $option_name ) {
369		$value = null;
		0 ignored issues – show Unused Code introduced 2017-07-25 00:48 UTC by Report Bug Copy Issue Report `$value` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
370		$constant = ( 'home' === $option_name )
371		? 'WP_HOME'
372		: 'WP_SITEURL';
373
374		// Since we disregard the constant for multisites in ms-default-filters.php,
375		// let's also use the db value if this is a multisite.
376		if ( ! is_multisite() && Constants::is_defined( $constant ) ) {
377		$value = Constants::get_constant( $constant );
378		} else {
379		// Let's get the option from the database so that we can bypass filters. This will help
380		// ensure that we get more uniform values.
381		$value = \Jetpack_Options::get_raw_option( $option_name );
382		}
383
384		return $value;
385		}
386
387		/**
388		* Normalize domains by removing www unless declared in the site's option.
389		*
390		* @param string $option Option value from the site.
391		* @param callable $url_function Function retrieving the URL to normalize.
392		* @return mixed\|string URL.
393		*/
394		public static function normalize_www_in_url( $option, $url_function ) {
395		$url = wp_parse_url( call_user_func( $url_function ) );
396		$option_url = wp_parse_url( get_option( $option ) );
397
398		if ( ! $option_url \|\| ! $url ) {
399		return $url;
400		}
401
402	View Code Duplication	if ( "www.{$option_url[ 'host' ]}" === $url['host'] ) {
403		// remove www if not present in option URL.
404		$url['host'] = $option_url['host'];
405		}
406	View Code Duplication	if ( "www.{$url[ 'host' ]}" === $option_url['host'] ) {
407		// add www if present in option URL.
408		$url['host'] = $option_url['host'];
409		}
410
411		$normalized_url = "{$url['scheme']}://{$url['host']}";
412		if ( isset( $url['path'] ) ) {
413		$normalized_url .= "{$url['path']}";
414		}
415
416		if ( isset( $url['query'] ) ) {
417		$normalized_url .= "?{$url['query']}";
418		}
419
420		return $normalized_url;
421		}
422
423		/**
424		* Return filtered value of get_plugins.
425		*
426		* @return mixed\|void
427		*/
428		public static function get_plugins() {
429		if ( ! function_exists( 'get_plugins' ) ) {
430		require_once ABSPATH . 'wp-admin/includes/plugin.php';
431		}
432
433		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
434		return apply_filters( 'all_plugins', get_plugins() );
435		}
436
437		/**
438		* Get custom action link tags that the plugin is using
439		* Ref: https://codex.wordpress.org/Plugin_API/Filter_Reference/plugin_action_links_(plugin_file_name)
440		*
441		* @param string $plugin_file_singular Particular plugin.
		0 ignored issues – show Documentation introduced 2019-09-27 16:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$plugin_file_singular` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
442		* @return array of plugin action links (key: link name value: url)
443		*/
444		public static function get_plugins_action_links( $plugin_file_singular = null ) {
445		// Some sites may have DOM disabled in PHP fail early.
446		if ( ! class_exists( 'DOMDocument' ) ) {
447		return array();
448		}
449		$plugins_action_links = get_option( 'jetpack_plugin_api_action_links', array() );
450		if ( ! empty( $plugins_action_links ) ) {
451		if ( is_null( $plugin_file_singular ) ) {
452		return $plugins_action_links;
453		}
454		return ( isset( $plugins_action_links[ $plugin_file_singular ] ) ? $plugins_action_links[ $plugin_file_singular ] : null );
455		}
456		return array();
457		}
458
459		/**
460		* Return the WP version as defined in the $wp_version global.
461		*
462		* @return string
463		*/
464		public static function wp_version() {
465		global $wp_version;
466		return $wp_version;
467		}
468
469		/**
470		* Return site icon url used on the site.
471		*
472		* @param int $size Size of requested icon in pixels.
473		* @return mixed\|string\|void
474		*/
475		public static function site_icon_url( $size = 512 ) {
476		$site_icon = get_site_icon_url( $size );
477		return $site_icon ? $site_icon : get_option( 'jetpack_site_icon_url' );
478		}
479
480		/**
481		* Return roles registered on the site.
482		*
483		* @return array
484		*/
485		public static function roles() {
486		$wp_roles = wp_roles();
487		return $wp_roles->roles;
488		}
489
490		/**
491		* Determine time zone from WordPress' options "timezone_string"
492		* and "gmt_offset".
493		*
494		* 1. Check if `timezone_string` is set and return it.
495		* 2. Check if `gmt_offset` is set, formats UTC-offset from it and return it.
496		* 3. Default to "UTC+0" if nothing is set.
497		*
498		* Note: This function is specifically not using wp_timezone() to keep consistency with
499		* the existing formatting of the timezone string.
500		*
501		* @return string
502		*/
503		public static function get_timezone() {
504		$timezone_string = get_option( 'timezone_string' );
505
506		if ( ! empty( $timezone_string ) ) {
507		return str_replace( '_', ' ', $timezone_string );
508		}
509
510		$gmt_offset = get_option( 'gmt_offset', 0 );
511
512		$formatted_gmt_offset = sprintf( '%+g', floatval( $gmt_offset ) );
513
514		$formatted_gmt_offset = str_replace(
515		array( '.25', '.5', '.75' ),
516		array( ':15', ':30', ':45' ),
517		(string) $formatted_gmt_offset
518		);
519
520		/* translators: %s is UTC offset, e.g. "+1" */
521		return sprintf( __( 'UTC%s', 'jetpack' ), $formatted_gmt_offset );
522		}
523
524		/**
525		* Return list of paused themes.
526		*
527		* @todo Remove function_exists check when WP 5.2 is the minimum.
528		*
529		* @return array\|bool Array of paused themes or false if unsupported.
530		*/
531		public static function get_paused_themes() {
532		if ( function_exists( 'wp_paused_themes' ) ) {
533		$paused_themes = wp_paused_themes();
534		return $paused_themes->get_all();
535		}
536		return false;
537		}
538
539		/**
540		* Return list of paused plugins.
541		*
542		* @todo Remove function_exists check when WP 5.2 is the minimum.
543		*
544		* @return array\|bool Array of paused plugins or false if unsupported.
545		*/
546		public static function get_paused_plugins() {
547		if ( function_exists( 'wp_paused_plugins' ) ) {
548		$paused_plugins = wp_paused_plugins();
549		return $paused_plugins->get_all();
550		}
551		return false;
552		}
553		}
554

Automattic / jetpack

Push — update/add-managed-wp-hosts ( 1b6daa )

Functions::get_shortcodes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like