Jetpack_Options::get_all_jetpack_options() - Code Metrics - Inspection of "Changelog: add #8039" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/changelog-55 ( a732ca...ae36cd )

by Jeremy

created 2017-10-24 13:43 UTC

Jetpack_Options::get_all_jetpack_options() B

↳ Parent: Project

Complexity

Conditions	4
Paths	2

Size

Total Lines	35
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	20
nc	2
nop	1
dl	0
loc	35
rs	8.5806
c	0
b	0
f	0

<?php

class Jetpack_Options {

	/**
	 * An array that maps a grouped option type to an option name.
	 * @var array
	 */
	private static $grouped_options = array(
		'compact' => 'jetpack_options',
		'private' => 'jetpack_private_options'
	);

	/**
	 * Returns an array of option names for a given type.
	 *
	 * @param string $type The type of option to return. Defaults to 'compact'.
	 *
	 * @return array
	 */
	public static function get_option_names( $type = 'compact' ) {
		switch ( $type ) {
		case 'non-compact' :
		case 'non_compact' :
			return array(
				'activated',
				'active_modules',
				'available_modules',
				'do_activate',
				'edit_links_calypso_redirect', // (bool) Whether post/page edit links on front end should point to Calypso.
				'log',
				'slideshow_background_color',
				'widget_twitter',
				'wpcc_options',
				'relatedposts',
				'file_data',
				'autoupdate_plugins',          // (array)  An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated
				'autoupdate_plugins_translations', // (array)  An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated translation files.
				'autoupdate_themes',           // (array)  An array of theme ids ( eg. twentyfourteen ) that should be autoupdated
				'autoupdate_themes_translations', // (array)  An array of theme ids ( eg. twentyfourteen ) that should autoupdated translation files.
				'autoupdate_core',             // (bool)   Whether or not to autoupdate core
				'autoupdate_translations',     // (bool)   Whether or not to autoupdate all translations
				'json_api_full_management',    // (bool)   Allow full management (eg. Activate, Upgrade plugins) of the site via the JSON API.
				'sync_non_public_post_stati',  // (bool)   Allow synchronisation of posts and pages with non-public status.
				'site_icon_url',               // (string) url to the full site icon
				'site_icon_id',                // (int)    Attachment id of the site icon file
				'dismissed_manage_banner',     // (bool) Dismiss Jetpack manage banner allows the user to dismiss the banner permanently
				'restapi_stats_cache',         // (array) Stats Cache data.
				'unique_connection',           // (array)  A flag to determine a unique connection to wordpress.com two values "connected" and "disconnected" with values for how many times each has occured
				'protect_whitelist',           // (array) IP Address for the Protect module to ignore
				'sync_error_idc',              // (bool|array) false or array containing the site's home and siteurl at time of IDC error
				'safe_mode_confirmed',         // (bool) True if someone confirms that this site was correctly put into safe mode automatically after an identity crisis is discovered.
				'migrate_for_idc',             // (bool) True if someone confirms that this site should migrate stats and subscribers from its previous URL
				'dismissed_connection_banner', // (bool) True if the connection banner has been dismissed
				'onboarding',                  // (string) Auth token to be used in the onboarding connection flow
			);

		case 'private' :
			return array(
				'blog_token',  // (string) The Client Secret/Blog Token of this site.
				'user_token',  // (string) The User Token of this site. (deprecated)
				'user_tokens'  // (array)  User Tokens for each user of this site who has connected to jetpack.wordpress.com.
			);

		case 'network' :
			return array(
				'onboarding',                   // (string) Auth token to be used in the onboarding connection flow
				'file_data'                     // (array) List of absolute paths to all Jetpack modules
			);
		}

		return array(
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
			'publicize_connections',        // (array)  An array of Publicize connections from WordPress.com
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
			'old_version',                  // (string) Used to determine which modules are the most recently added. previous_version:time
			'fallback_no_verify_ssl_certs', // (int)    Flag for determining if this host must skip SSL Certificate verification due to misconfigured SSL.
			'time_diff',                    // (int)    Offset between Jetpack server's clocks and this server's clocks. Jetpack Server Time = time() + (int) Jetpack_Options::get_option( 'time_diff' )
			'public',                       // (int|bool) If we think this site is public or not (1, 0), false if we haven't yet tried to figure it out.
			'videopress',                   // (array)  VideoPress options array.
			'is_network_site',              // (int|bool) If we think this site is a network or a single blog (1, 0), false if we haven't yet tried to figue it out.
			'social_links',                 // (array)  The specified links for each social networking site.
			'identity_crisis_whitelist',    // (array)  An array of options, each having an array of the values whitelisted for it.
			'gplus_authors',                // (array)  The Google+ authorship information for connected users.
			'last_heartbeat',               // (int)    The timestamp of the last heartbeat that fired.
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
			'hide_jitm',                    // (array)  A list of just in time messages that we should not show because they have been dismissed by the user
			'custom_css_4.7_migration',     // (bool)   Whether Custom CSS has scanned for and migrated any legacy CSS CPT entries to the new Core format.
			'image_widget_migration',       // (bool)   Whether any legacy Image Widgets have been converted to the new Core widget
		);
	}

	/**
	 * Is the option name valid?
	 *
	 * @param string      $name  The name of the option
	 * @param string|null $group The name of the group that the option is in. Default to null, which will search non_compact.
	 *
	 * @return bool Is the option name valid?
	 */
	public static function is_valid( $name, $group = null ) {
		if ( is_array( $name ) ) {
			$compact_names = array();
			foreach ( array_keys( self::$grouped_options ) as $_group ) {
				$compact_names = array_merge( $compact_names, self::get_option_names( $_group ) );
			}

			$result = array_diff( $name, self::get_option_names( 'non_compact' ), $compact_names );

			return empty( $result );
		}

		if ( is_null( $group ) || 'non_compact' === $group ) {
			if ( in_array( $name, self::get_option_names( $group ) ) ) {
				return true;
			}
		}

		foreach ( array_keys( self::$grouped_options ) as $_group ) {
			if ( is_null( $group ) || $group === $_group ) {
				if ( in_array( $name, self::get_option_names( $_group ) ) ) {
					return true;
				}
			}
		}

		return false;
	}

	/**
	 * Checks if an option must be saved for the whole network in WP Multisite
	 *
	 * @param string $option_name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
	 *
	 * @return bool
	 */
	public static function is_network_option( $option_name ) {
		if ( ! is_multisite() ) {
			return false;
		}
		return in_array( $option_name, self::get_option_names( 'network' ) );
	}

	/**
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
	 *
	 * @param string $name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
	 * @param mixed $default (optional)
	 *
	 * @return mixed
	 */
	public static function get_option( $name, $default = false ) {
		if ( self::is_valid( $name, 'non_compact' ) ) {
			if ( self::is_network_option( $name ) ) {
				return get_site_option( "jetpack_$name", $default );
			}

			return get_option( "jetpack_$name", $default );
		}

		foreach ( array_keys( self::$grouped_options ) as $group ) {
			if ( self::is_valid( $name, $group ) ) {
				return self::get_grouped_option( $group, $name, $default );
			}
		}

		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );

		return $default;
	}

	/**
	 * Returns the requested option, and ensures it's autoloaded in the future.
	 * This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
	 *
	 * @param string $name Option name
	 * @param mixed $default (optional)
	 *
	 * @return mixed
	 */
	public static function get_option_and_ensure_autoload( $name, $default ) {
		// In this function the name is not adjusted by prefixing jetpack_
		// so if it has already prefixed, we'll replace it and then
		// check if the option name is a network option or not
		$jetpack_name = preg_replace( '/^jetpack_/', '', $name, 1 );
		$is_network_option = self::is_network_option( $jetpack_name );
		$value = $is_network_option ? get_site_option( $name ) : get_option( $name );

		if ( false === $value && false !== $default ) {
			if ( $is_network_option ) {
				update_site_option( $name, $default );
			} else {
				update_option( $name, $default );
			}
			$value = $default;
		}

		return $value;
	}

	private static function update_grouped_option( $group, $name, $value ) {
		$options = get_option( self::$grouped_options[ $group ] );
		if ( ! is_array( $options ) ) {
			$options = array();
		}
		$options[ $name ] = $value;

		return update_option( self::$grouped_options[ $group ], $options );
	}

	/**
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
	 *
	 * @param string $name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
	 * @param mixed $value Option value
	 * @param string $autoload If not compact option, allows specifying whether to autoload or not.

	 *
	 * @return bool Was the option successfully updated?
	 */
	public static function update_option( $name, $value, $autoload = null ) {
		/**
		 * Fires before Jetpack updates a specific option.
		 *
		 * @since 3.0.0
		 *
		 * @param str $name The name of the option being updated.
		 * @param mixed $value The new value of the option.
		 */
		do_action( 'pre_update_jetpack_option_' . $name, $name, $value );
		if ( self::is_valid( $name, 'non_compact' ) ) {
			if ( self::is_network_option( $name ) ) {
				return update_site_option( "jetpack_$name", $value );
			}

			return update_option( "jetpack_$name", $value, $autoload );

		}

		foreach ( array_keys( self::$grouped_options ) as $group ) {
			if ( self::is_valid( $name, $group ) ) {
				return self::update_grouped_option( $group, $name, $value );
			}
		}

		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );

		return false;
	}

	/**
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
	 *
	 * @param array $array array( option name => option value, ... )
	 */
	public static function update_options( $array ) {
		$names = array_keys( $array );

		foreach ( array_diff( $names, self::get_option_names(), self::get_option_names( 'non_compact' ), self::get_option_names( 'private' ) ) as $unknown_name ) {
			trigger_error( sprintf( 'Invalid Jetpack option name: %s', $unknown_name ), E_USER_WARNING );
			unset( $array[ $unknown_name ] );
		}

		foreach ( $names as $name ) {
			self::update_option( $name, $array[ $name ] );
		}
	}

	/**
	 * Deletes the given option.  May be passed multiple option names as an array.
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
	 *
	 * @param string|array $names Option names. They must come _without_ `jetpack_%` prefix. The method will prefix the option names.
	 *
	 * @return bool Was the option successfully deleted?
	 */
	public static function delete_option( $names ) {
		$result = true;
		$names  = (array) $names;

		if ( ! self::is_valid( $names ) ) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			trigger_error( sprintf( 'Invalid Jetpack option names: %s', print_r( $names, 1 ) ), E_USER_WARNING );
			return false;
		}

		foreach ( array_intersect( $names, self::get_option_names( 'non_compact' ) ) as $name ) {
			if ( self::is_network_option( $name ) ) {
				$result = delete_site_option( "jetpack_$name" );
			} else {
				$result = delete_option( "jetpack_$name" );
			}

		}

		foreach ( array_keys( self::$grouped_options ) as $group ) {
			if ( ! self::delete_grouped_option( $group, $names ) ) {
				$result = false;
			}
		}

		return $result;
	}

	private static function get_grouped_option( $group, $name, $default ) {
		$options = get_option( self::$grouped_options[ $group ] );
		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
			return $options[ $name ];
		}

		return $default;
	}

	private static function delete_grouped_option( $group, $names ) {
		$options = get_option( self::$grouped_options[ $group ], array() );

		$to_delete = array_intersect( $names, self::get_option_names( $group ), array_keys( $options ) );
		if ( $to_delete ) {

			foreach ( $to_delete as $name ) {
				unset( $options[ $name ] );
			}

			return update_option( self::$grouped_options[ $group ], $options );
		}

		return true;
	}

	// Raw option methods allow Jetpack to get / update / delete options via direct DB queries, including options
	// that are not created by the Jetpack plugin. This is helpful only in rare cases when we need to bypass
	// cache and filters.

	/**
	 * Deletes an option via $wpdb query.
	 *
	 * @param string $name Option name.
	 *
	 * @return bool Is the option deleted?
	 */
	static function delete_raw_option( $name ) {
		if ( self::bypass_raw_option( $name ) ) {
			return delete_option( $name );
		}
		global $wpdb;
		$result = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name = %s", $name ) );
		return $result;
	}

	/**
	 * Updates an option via $wpdb query.
	 *
	 * @param string $name Option name.
	 * @param mixed $value Option value.
	 * @param bool $autoload Specifying whether to autoload or not.
	 *
	 * @return bool Is the option updated?
	 */
	static function update_raw_option( $name, $value, $autoload = false ) {
		if ( self::bypass_raw_option( $name ) ) {
			return update_option( $name, $value, $autoload );
		}
		global $wpdb;
		$autoload_value = $autoload ? 'yes' : 'no';

		$serialized_value = maybe_serialize( $value );
		// try updating, if no update then insert
		// TODO: try to deal with the fact that unchanged values can return updated_num = 0

		// below we used "insert ignore" to at least suppress the resulting error
		$updated_num = $wpdb->query(
			$wpdb->prepare(
				"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
				$serialized_value,
				$name
			)
		);

		if ( ! $updated_num ) {
			$updated_num = $wpdb->query(
				$wpdb->prepare(
					"INSERT IGNORE INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, '$autoload_value' )",
					$name,
					$serialized_value
				)
			);
		}
		return $updated_num;
	}

	/**
	 * Gets an option via $wpdb query.
	 *
	 * @param string $name Option name.
	 * @param mixed $default Default option value if option is not found.
	 *
	 * @return mixed Option value, or null if option is not found and default is not specified.
	 */
	static function get_raw_option( $name, $default = null ) {
		if ( self::bypass_raw_option( $name ) ) {
			return get_option( $name, $default );
		}

		global $wpdb;
		$value = $wpdb->get_var(
			$wpdb->prepare(
				"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
				$name
			)
		);
		$value = maybe_unserialize( $value );

		if ( $value === null && $default !== null ) {
			return $default;
		}

		return $value;
	}

	/**
	 * This function checks for a constant that, if present, will disable direct DB queries Jetpack uses to manage certain options and force Jetpack to always use Options API instead.
	 * Options can be selectively managed via a blacklist by filtering option names via the jetpack_disabled_raw_option filter.
	 *
	 * @param $name Option name
	 *
	 * @return bool
	 */
	static function bypass_raw_option( $name ) {

		if ( Jetpack_Constants::get_constant( 'JETPACK_DISABLE_RAW_OPTIONS' ) ) {
			return true;
		}
		/**
		 * Allows to disable particular raw options.
		 * @since 5.5.0
		 *
		 * @param array $disabled_raw_options An array of option names that you can selectively blacklist from being managed via direct database queries.
		 */
		$disabled_raw_options = apply_filters( 'jetpack_disabled_raw_options', array() );
		return isset( $disabled_raw_options[ $name ] );
	}
}

1		<?php
2
3		class Jetpack_Options {
4
5		/**
6		* An array that maps a grouped option type to an option name.
7		* @var array
8		*/
9		private static $grouped_options = array(
10		'compact' => 'jetpack_options',
11		'private' => 'jetpack_private_options'
12		);
13
14		/**
15		* Returns an array of option names for a given type.
16		*
17		* @param string $type The type of option to return. Defaults to 'compact'.
18		*
19		* @return array
20		*/
21		public static function get_option_names( $type = 'compact' ) {
22		switch ( $type ) {
23		case 'non-compact' :
24		case 'non_compact' :
25		return array(
26		'activated',
27		'active_modules',
28		'available_modules',
29		'do_activate',
30		'edit_links_calypso_redirect', // (bool) Whether post/page edit links on front end should point to Calypso.
31		'log',
32		'slideshow_background_color',
33		'widget_twitter',
34		'wpcc_options',
35		'relatedposts',
36		'file_data',
37		'autoupdate_plugins', // (array) An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated
38		'autoupdate_plugins_translations', // (array) An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated translation files.
39		'autoupdate_themes', // (array) An array of theme ids ( eg. twentyfourteen ) that should be autoupdated
40		'autoupdate_themes_translations', // (array) An array of theme ids ( eg. twentyfourteen ) that should autoupdated translation files.
41		'autoupdate_core', // (bool) Whether or not to autoupdate core
42		'autoupdate_translations', // (bool) Whether or not to autoupdate all translations
43		'json_api_full_management', // (bool) Allow full management (eg. Activate, Upgrade plugins) of the site via the JSON API.
44		'sync_non_public_post_stati', // (bool) Allow synchronisation of posts and pages with non-public status.
45		'site_icon_url', // (string) url to the full site icon
46		'site_icon_id', // (int) Attachment id of the site icon file
47		'dismissed_manage_banner', // (bool) Dismiss Jetpack manage banner allows the user to dismiss the banner permanently
48		'restapi_stats_cache', // (array) Stats Cache data.
49		'unique_connection', // (array) A flag to determine a unique connection to wordpress.com two values "connected" and "disconnected" with values for how many times each has occured
50		'protect_whitelist', // (array) IP Address for the Protect module to ignore
51		'sync_error_idc', // (bool\|array) false or array containing the site's home and siteurl at time of IDC error
52		'safe_mode_confirmed', // (bool) True if someone confirms that this site was correctly put into safe mode automatically after an identity crisis is discovered.
53		'migrate_for_idc', // (bool) True if someone confirms that this site should migrate stats and subscribers from its previous URL
54		'dismissed_connection_banner', // (bool) True if the connection banner has been dismissed
55		'onboarding', // (string) Auth token to be used in the onboarding connection flow
56		);
57
58		case 'private' :
59		return array(
60		'blog_token', // (string) The Client Secret/Blog Token of this site.
61		'user_token', // (string) The User Token of this site. (deprecated)
62		'user_tokens' // (array) User Tokens for each user of this site who has connected to jetpack.wordpress.com.
63		);
64
65		case 'network' :
66		return array(
67		'onboarding', // (string) Auth token to be used in the onboarding connection flow
68		'file_data' // (array) List of absolute paths to all Jetpack modules
69		);
70		}
71
72		return array(
73		'id', // (int) The Client ID/WP.com Blog ID of this site.
74		'publicize_connections', // (array) An array of Publicize connections from WordPress.com
75		'master_user', // (int) The local User ID of the user who connected this site to jetpack.wordpress.com.
76		'version', // (string) Used during upgrade procedure to auto-activate new modules. version:time
77		'old_version', // (string) Used to determine which modules are the most recently added. previous_version:time
78		'fallback_no_verify_ssl_certs', // (int) Flag for determining if this host must skip SSL Certificate verification due to misconfigured SSL.
79		'time_diff', // (int) Offset between Jetpack server's clocks and this server's clocks. Jetpack Server Time = time() + (int) Jetpack_Options::get_option( 'time_diff' )
80		'public', // (int\|bool) If we think this site is public or not (1, 0), false if we haven't yet tried to figure it out.
81		'videopress', // (array) VideoPress options array.
82		'is_network_site', // (int\|bool) If we think this site is a network or a single blog (1, 0), false if we haven't yet tried to figue it out.
83		'social_links', // (array) The specified links for each social networking site.
84		'identity_crisis_whitelist', // (array) An array of options, each having an array of the values whitelisted for it.
85		'gplus_authors', // (array) The Google+ authorship information for connected users.
86		'last_heartbeat', // (int) The timestamp of the last heartbeat that fired.
87		'jumpstart', // (string) A flag for whether or not to show the Jump Start. Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
88		'hide_jitm', // (array) A list of just in time messages that we should not show because they have been dismissed by the user
89		'custom_css_4.7_migration', // (bool) Whether Custom CSS has scanned for and migrated any legacy CSS CPT entries to the new Core format.
90		'image_widget_migration', // (bool) Whether any legacy Image Widgets have been converted to the new Core widget
91		);
92		}
93
94		/**
95		* Is the option name valid?
96		*
97		* @param string $name The name of the option
98		* @param string\|null $group The name of the group that the option is in. Default to null, which will search non_compact.
99		*
100		* @return bool Is the option name valid?
101		*/
102		public static function is_valid( $name, $group = null ) {
103		if ( is_array( $name ) ) {
104		$compact_names = array();
105		foreach ( array_keys( self::$grouped_options ) as $_group ) {
106		$compact_names = array_merge( $compact_names, self::get_option_names( $_group ) );
107		}
108
109		$result = array_diff( $name, self::get_option_names( 'non_compact' ), $compact_names );
110
111		return empty( $result );
112		}
113
114	View Code Duplication	if ( is_null( $group ) \|\| 'non_compact' === $group ) {
115		if ( in_array( $name, self::get_option_names( $group ) ) ) {
116		return true;
117		}
118		}
119
120		foreach ( array_keys( self::$grouped_options ) as $_group ) {
121	View Code Duplication	if ( is_null( $group ) \|\| $group === $_group ) {
122		if ( in_array( $name, self::get_option_names( $_group ) ) ) {
123		return true;
124		}
125		}
126		}
127
128		return false;
129		}
130
131		/**
132		* Checks if an option must be saved for the whole network in WP Multisite
133		*
134		* @param string $option_name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
135		*
136		* @return bool
137		*/
138		public static function is_network_option( $option_name ) {
139		if ( ! is_multisite() ) {
140		return false;
141		}
142		return in_array( $option_name, self::get_option_names( 'network' ) );
143		}
144
145		/**
146		* Returns the requested option. Looks in jetpack_options or jetpack_$name as appropriate.
147		*
148		* @param string $name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
149		* @param mixed $default (optional)
150		*
151		* @return mixed
152		*/
153		public static function get_option( $name, $default = false ) {
154	View Code Duplication	if ( self::is_valid( $name, 'non_compact' ) ) {
155		if ( self::is_network_option( $name ) ) {
156		return get_site_option( "jetpack_$name", $default );
157		}
158
159		return get_option( "jetpack_$name", $default );
160		}
161
162		foreach ( array_keys( self::$grouped_options ) as $group ) {
163		if ( self::is_valid( $name, $group ) ) {
164		return self::get_grouped_option( $group, $name, $default );
165		}
166		}
167
168		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
169
170		return $default;
171		}
172
173		/**
174		* Returns the requested option, and ensures it's autoloaded in the future.
175		* This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
176		*
177		* @param string $name Option name
178		* @param mixed $default (optional)
179		*
180		* @return mixed
181		*/
182		public static function get_option_and_ensure_autoload( $name, $default ) {
183		// In this function the name is not adjusted by prefixing jetpack_
184		// so if it has already prefixed, we'll replace it and then
185		// check if the option name is a network option or not
186		$jetpack_name = preg_replace( '/^jetpack_/', '', $name, 1 );
187		$is_network_option = self::is_network_option( $jetpack_name );
188		$value = $is_network_option ? get_site_option( $name ) : get_option( $name );
189
190		if ( false === $value && false !== $default ) {
191		if ( $is_network_option ) {
192		update_site_option( $name, $default );
193		} else {
194		update_option( $name, $default );
195		}
196		$value = $default;
197		}
198
199		return $value;
200		}
201
202		private static function update_grouped_option( $group, $name, $value ) {
203		$options = get_option( self::$grouped_options[ $group ] );
204		if ( ! is_array( $options ) ) {
205		$options = array();
206		}
207		$options[ $name ] = $value;
208
209		return update_option( self::$grouped_options[ $group ], $options );
210		}
211
212		/**
213		* Updates the single given option. Updates jetpack_options or jetpack_$name as appropriate.
214		*
215		* @param string $name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
216		* @param mixed $value Option value
217		* @param string $autoload If not compact option, allows specifying whether to autoload or not.
		0 ignored issues – show Documentation introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report Should the type for parameter `$autoload` 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...
218		*
219		* @return bool Was the option successfully updated?
220		*/
221		public static function update_option( $name, $value, $autoload = null ) {
222		/**
223		* Fires before Jetpack updates a specific option.
224		*
225		* @since 3.0.0
226		*
227		* @param str $name The name of the option being updated.
228		* @param mixed $value The new value of the option.
229		*/
230		do_action( 'pre_update_jetpack_option_' . $name, $name, $value );
231	View Code Duplication	if ( self::is_valid( $name, 'non_compact' ) ) {
232		if ( self::is_network_option( $name ) ) {
233		return update_site_option( "jetpack_$name", $value );
234		}
235
236		return update_option( "jetpack_$name", $value, $autoload );
237
238		}
239
240		foreach ( array_keys( self::$grouped_options ) as $group ) {
241		if ( self::is_valid( $name, $group ) ) {
242		return self::update_grouped_option( $group, $name, $value );
243		}
244		}
245
246		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
247
248		return false;
249		}
250
251		/**
252		* Updates the multiple given options. Updates jetpack_options and/or jetpack_$name as appropriate.
253		*
254		* @param array $array array( option name => option value, ... )
255		*/
256		public static function update_options( $array ) {
257		$names = array_keys( $array );
258
259		foreach ( array_diff( $names, self::get_option_names(), self::get_option_names( 'non_compact' ), self::get_option_names( 'private' ) ) as $unknown_name ) {
260		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $unknown_name ), E_USER_WARNING );
261		unset( $array[ $unknown_name ] );
262		}
263
264		foreach ( $names as $name ) {
265		self::update_option( $name, $array[ $name ] );
266		}
267		}
268
269		/**
270		* Deletes the given option. May be passed multiple option names as an array.
271		* Updates jetpack_options and/or deletes jetpack_$name as appropriate.
272		*
273		* @param string\|array $names Option names. They must come _without_ `jetpack_%` prefix. The method will prefix the option names.
274		*
275		* @return bool Was the option successfully deleted?
276		*/
277		public static function delete_option( $names ) {
278		$result = true;
279		$names = (array) $names;
280
281		if ( ! self::is_valid( $names ) ) {
		0 ignored issues – show Documentation introduced 2016-11-09 18:02 UTC by Report Bug Copy Issue Report `$names` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
282		trigger_error( sprintf( 'Invalid Jetpack option names: %s', print_r( $names, 1 ) ), E_USER_WARNING );
283		return false;
284		}
285
286		foreach ( array_intersect( $names, self::get_option_names( 'non_compact' ) ) as $name ) {
287		if ( self::is_network_option( $name ) ) {
288		$result = delete_site_option( "jetpack_$name" );
289		} else {
290		$result = delete_option( "jetpack_$name" );
291		}
292
293		}
294
295		foreach ( array_keys( self::$grouped_options ) as $group ) {
296		if ( ! self::delete_grouped_option( $group, $names ) ) {
297		$result = false;
298		}
299		}
300
301		return $result;
302		}
303
304		private static function get_grouped_option( $group, $name, $default ) {
305		$options = get_option( self::$grouped_options[ $group ] );
306		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
307		return $options[ $name ];
308		}
309
310		return $default;
311		}
312
313		private static function delete_grouped_option( $group, $names ) {
314		$options = get_option( self::$grouped_options[ $group ], array() );
315
316		$to_delete = array_intersect( $names, self::get_option_names( $group ), array_keys( $options ) );
317		if ( $to_delete ) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The expression `$to_delete` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
318		foreach ( $to_delete as $name ) {
319		unset( $options[ $name ] );
320		}
321
322		return update_option( self::$grouped_options[ $group ], $options );
323		}
324
325		return true;
326		}
327
328		// Raw option methods allow Jetpack to get / update / delete options via direct DB queries, including options
329		// that are not created by the Jetpack plugin. This is helpful only in rare cases when we need to bypass
330		// cache and filters.
331
332		/**
333		* Deletes an option via $wpdb query.
334		*
335		* @param string $name Option name.
336		*
337		* @return bool Is the option deleted?
338		*/
339		static function delete_raw_option( $name ) {
340		if ( self::bypass_raw_option( $name ) ) {
341		return delete_option( $name );
342		}
343		global $wpdb;
344		$result = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name = %s", $name ) );
345		return $result;
346		}
347
348		/**
349		* Updates an option via $wpdb query.
350		*
351		* @param string $name Option name.
352		* @param mixed $value Option value.
353		* @param bool $autoload Specifying whether to autoload or not.
354		*
355		* @return bool Is the option updated?
356		*/
357		static function update_raw_option( $name, $value, $autoload = false ) {
358		if ( self::bypass_raw_option( $name ) ) {
359		return update_option( $name, $value, $autoload );
360		}
361		global $wpdb;
362		$autoload_value = $autoload ? 'yes' : 'no';
363
364		$serialized_value = maybe_serialize( $value );
365		// try updating, if no update then insert
366		// TODO: try to deal with the fact that unchanged values can return updated_num = 0
		0 ignored issues – show Coding Style Best Practice introduced 2016-10-17 23:38 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
367		// below we used "insert ignore" to at least suppress the resulting error
368		$updated_num = $wpdb->query(
369		$wpdb->prepare(
370		"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
371		$serialized_value,
372		$name
373		)
374		);
375
376		if ( ! $updated_num ) {
377		$updated_num = $wpdb->query(
378		$wpdb->prepare(
379		"INSERT IGNORE INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, '$autoload_value' )",
380		$name,
381		$serialized_value
382		)
383		);
384		}
385		return $updated_num;
386		}
387
388		/**
389		* Gets an option via $wpdb query.
390		*
391		* @param string $name Option name.
392		* @param mixed $default Default option value if option is not found.
393		*
394		* @return mixed Option value, or null if option is not found and default is not specified.
395		*/
396		static function get_raw_option( $name, $default = null ) {
397		if ( self::bypass_raw_option( $name ) ) {
398		return get_option( $name, $default );
399		}
400
401		global $wpdb;
402		$value = $wpdb->get_var(
403		$wpdb->prepare(
404		"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
405		$name
406		)
407		);
408		$value = maybe_unserialize( $value );
409
410		if ( $value === null && $default !== null ) {
411		return $default;
412		}
413
414		return $value;
415		}
416
417		/**
418		* This function checks for a constant that, if present, will disable direct DB queries Jetpack uses to manage certain options and force Jetpack to always use Options API instead.
419		* Options can be selectively managed via a blacklist by filtering option names via the jetpack_disabled_raw_option filter.
420		*
421		* @param $name Option name
422		*
423		* @return bool
424		*/
425		static function bypass_raw_option( $name ) {
426
427		if ( Jetpack_Constants::get_constant( 'JETPACK_DISABLE_RAW_OPTIONS' ) ) {
428		return true;
429		}
430		/**
431		* Allows to disable particular raw options.
432		* @since 5.5.0
433		*
434		* @param array $disabled_raw_options An array of option names that you can selectively blacklist from being managed via direct database queries.
435		*/
436		$disabled_raw_options = apply_filters( 'jetpack_disabled_raw_options', array() );
437		return isset( $disabled_raw_options[ $name ] );
438		}
439		}

Automattic / jetpack

Push — add/changelog-55 ( a732ca...ae36cd )

Jetpack_Options::get_all_jetpack_options() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like