Archived
221 lines
7.1 KiB
PHP
221 lines
7.1 KiB
PHP
<?php
|
|
/**
|
|
* @package WPSEO\Internals\Options
|
|
*/
|
|
|
|
/**
|
|
* Site option for Multisite installs only
|
|
*
|
|
* Overloads a number of methods of the abstract class to ensure the use of the correct site_option
|
|
* WP functions.
|
|
*/
|
|
class WPSEO_Option_MS extends WPSEO_Option {
|
|
|
|
/**
|
|
* @var string option name
|
|
*/
|
|
public $option_name = 'wpseo_ms';
|
|
|
|
/**
|
|
* @var string option group name for use in settings forms
|
|
*/
|
|
public $group_name = 'yoast_wpseo_multisite_options';
|
|
|
|
/**
|
|
* @var bool whether to include the option in the return for WPSEO_Options::get_all()
|
|
*/
|
|
public $include_in_all = false;
|
|
|
|
/**
|
|
* @var bool whether this option is only for when the install is multisite
|
|
*/
|
|
public $multisite_only = true;
|
|
|
|
/**
|
|
* @var array Array of defaults for the option
|
|
* Shouldn't be requested directly, use $this->get_defaults();
|
|
*/
|
|
protected $defaults = array(
|
|
'access' => 'admin',
|
|
'defaultblog' => '', // Numeric blog ID or empty.
|
|
);
|
|
|
|
/**
|
|
* @var array $allowed_access_options Available options for the 'access' setting
|
|
* Used for input validation
|
|
*
|
|
* @static
|
|
*
|
|
* @internal Important: Make sure the options added to the array here are in line with the keys
|
|
* for the options set for the select box in the admin/pages/network.php file
|
|
*/
|
|
public static $allowed_access_options = array(
|
|
'admin',
|
|
'superadmin',
|
|
);
|
|
|
|
|
|
/**
|
|
* Get the singleton instance of this class
|
|
*
|
|
* @return object
|
|
*/
|
|
public static function get_instance() {
|
|
if ( ! ( self::$instance instanceof self ) ) {
|
|
self::$instance = new self();
|
|
}
|
|
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* Only run parent constructor in multisite context.
|
|
*/
|
|
public function __construct() {
|
|
if ( is_multisite() ) {
|
|
parent::__construct();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add filters to make sure that the option default is returned if the option is not set
|
|
*
|
|
* @return void
|
|
*/
|
|
public function add_default_filters() {
|
|
// Don't change, needs to check for false as could return prio 0 which would evaluate to false.
|
|
if ( has_filter( 'default_site_option_' . $this->option_name, array( $this, 'get_defaults' ) ) === false ) {
|
|
add_filter( 'default_site_option_' . $this->option_name, array( $this, 'get_defaults' ) );
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Remove the default filters.
|
|
* Called from the validate() method to prevent failure to add new options
|
|
*
|
|
* @return void
|
|
*/
|
|
public function remove_default_filters() {
|
|
remove_filter( 'default_site_option_' . $this->option_name, array( $this, 'get_defaults' ) );
|
|
}
|
|
|
|
|
|
/**
|
|
* Add filters to make sure that the option is merged with its defaults before being returned
|
|
*
|
|
* @return void
|
|
*/
|
|
public function add_option_filters() {
|
|
// Don't change, needs to check for false as could return prio 0 which would evaluate to false.
|
|
if ( has_filter( 'site_option_' . $this->option_name, array( $this, 'get_option' ) ) === false ) {
|
|
add_filter( 'site_option_' . $this->option_name, array( $this, 'get_option' ) );
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Remove the option filters.
|
|
* Called from the clean_up methods to make sure we retrieve the original old option
|
|
*
|
|
* @return void
|
|
*/
|
|
public function remove_option_filters() {
|
|
remove_filter( 'site_option_' . $this->option_name, array( $this, 'get_option' ) );
|
|
}
|
|
|
|
|
|
/* *********** METHODS influencing add_uption(), update_option() and saving from admin pages *********** */
|
|
|
|
|
|
/**
|
|
* Validate the option
|
|
*
|
|
* @param array $dirty New value for the option.
|
|
* @param array $clean Clean value for the option, normally the defaults.
|
|
* @param array $old Old value of the option.
|
|
*
|
|
* @return array Validated clean value for the option to be saved to the database
|
|
*/
|
|
protected function validate_option( $dirty, $clean, $old ) {
|
|
|
|
foreach ( $clean as $key => $value ) {
|
|
switch ( $key ) {
|
|
case 'access':
|
|
if ( isset( $dirty[ $key ] ) && in_array( $dirty[ $key ], self::$allowed_access_options, true ) ) {
|
|
$clean[ $key ] = $dirty[ $key ];
|
|
}
|
|
elseif ( function_exists( 'add_settings_error' ) ) {
|
|
add_settings_error(
|
|
$this->group_name, // Slug title of the setting.
|
|
'_' . $key, // Suffix-id for the error message box.
|
|
/* translators: %1$s expands to the option name and %2$sexpands to Yoast SEO */
|
|
sprintf( __( '%1$s is not a valid choice for who should be allowed access to the %2$s settings. Value reset to the default.', 'wordpress-seo' ), esc_html( sanitize_text_field( $dirty[ $key ] ) ), 'Yoast SEO' ), // The error message.
|
|
'error' // Error type, either 'error' or 'updated'.
|
|
);
|
|
}
|
|
break;
|
|
|
|
|
|
case 'defaultblog':
|
|
if ( isset( $dirty[ $key ] ) && ( $dirty[ $key ] !== '' && $dirty[ $key ] !== '-' ) ) {
|
|
$int = WPSEO_Utils::validate_int( $dirty[ $key ] );
|
|
if ( $int !== false && $int > 0 ) {
|
|
// Check if a valid blog number has been received.
|
|
$exists = get_blog_details( $int, false );
|
|
if ( $exists && $exists->deleted == 0 ) {
|
|
$clean[ $key ] = $int;
|
|
}
|
|
elseif ( function_exists( 'add_settings_error' ) ) {
|
|
add_settings_error(
|
|
$this->group_name, // Slug title of the setting.
|
|
'_' . $key, // Suffix-id for the error message box.
|
|
esc_html__( 'The default blog setting must be the numeric blog id of the blog you want to use as default.', 'wordpress-seo' ) . '<br>' . sprintf( esc_html__( 'This must be an existing blog. Blog %s does not exist or has been marked as deleted.', 'wordpress-seo' ), '<strong>' . esc_html( sanitize_text_field( $dirty[ $key ] ) ) . '</strong>' ), // The error message.
|
|
'error' // Error type, either 'error' or 'updated'.
|
|
);
|
|
}
|
|
unset( $exists );
|
|
}
|
|
elseif ( function_exists( 'add_settings_error' ) ) {
|
|
add_settings_error(
|
|
$this->group_name, // Slug title of the setting.
|
|
'_' . $key, // Suffix-id for the error message box.
|
|
esc_html__( 'The default blog setting must be the numeric blog id of the blog you want to use as default.', 'wordpress-seo' ) . '<br>' . esc_html__( 'No numeric value was received.', 'wordpress-seo' ), // The error message.
|
|
'error' // Error type, either 'error' or 'updated'.
|
|
);
|
|
}
|
|
unset( $int );
|
|
}
|
|
break;
|
|
|
|
default:
|
|
$clean[ $key ] = ( isset( $dirty[ $key ] ) ? WPSEO_Utils::validate_bool( $dirty[ $key ] ) : false );
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $clean;
|
|
}
|
|
|
|
|
|
/**
|
|
* Clean a given option value
|
|
*
|
|
* @param array $option_value Old (not merged with defaults or filtered) option value to
|
|
* clean according to the rules for this option.
|
|
* @param string $current_version (optional) Version from which to upgrade, if not set,
|
|
* version specific upgrades will be disregarded.
|
|
* @param array $all_old_option_values (optional) Only used when importing old options to have
|
|
* access to the real old values, in contrast to the saved ones.
|
|
*
|
|
* @return array Cleaned option
|
|
*/
|
|
|
|
/*
|
|
Protected function clean_option( $option_value, $current_version = null, $all_old_option_values = null ) {
|
|
|
|
return $option_value;
|
|
}
|
|
*/
|
|
}
|