Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Network

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Implements a network settings API for the plugin's multisite settings.

[8] Fix | Delete

[9] Fix | Delete

class Yoast_Network_Settings_API {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Registered network settings.

[13] Fix | Delete

[14] Fix | Delete

* @var array

[15] Fix | Delete

[16] Fix | Delete

private $registered_settings = [];

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Options whitelist, keyed by option group.

[20] Fix | Delete

[21] Fix | Delete

* @var array

[22] Fix | Delete

[23] Fix | Delete

private $whitelist_options = [];

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* The singleton instance of this class.

[27] Fix | Delete

[28] Fix | Delete

* @var Yoast_Network_Settings_API

[29] Fix | Delete

[30] Fix | Delete

private static $instance = null;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Registers a network setting and its data.

[34] Fix | Delete

[35] Fix | Delete

* @param string $option_group The group the network option is part of.

[36] Fix | Delete

* @param string $option_name The name of the network option to sanitize and save.

[37] Fix | Delete

* @param array $args {

[38] Fix | Delete

* Optional. Data used to describe the network setting when registered.

[39] Fix | Delete

[40] Fix | Delete

* @type callable $sanitize_callback A callback function that sanitizes the network option's value.

[41] Fix | Delete

* @type mixed $default Default value when calling `get_network_option()`.

[42] Fix | Delete

* }

[43] Fix | Delete

[44] Fix | Delete

* @return void

[45] Fix | Delete

[46] Fix | Delete

public function register_setting( $option_group, $option_name, $args = [] ) {

[47] Fix | Delete

[48] Fix | Delete

$defaults = [

[49] Fix | Delete

'group' => $option_group,

[50] Fix | Delete

'sanitize_callback' => null,

[51] Fix | Delete

];

[52] Fix | Delete

$args = wp_parse_args( $args, $defaults );

[53] Fix | Delete

[54] Fix | Delete

if ( ! isset( $this->whitelist_options[ $option_group ] ) ) {

[55] Fix | Delete

$this->whitelist_options[ $option_group ] = [];

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

$this->whitelist_options[ $option_group ][] = $option_name;

[59] Fix | Delete

[60] Fix | Delete

if ( ! empty( $args['sanitize_callback'] ) ) {

[61] Fix | Delete

add_filter( "sanitize_option_{$option_name}", [ $this, 'filter_sanitize_option' ], 10, 2 );

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

if ( array_key_exists( 'default', $args ) ) {

[65] Fix | Delete

add_filter( "default_site_option_{$option_name}", [ $this, 'filter_default_option' ], 10, 2 );

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

$this->registered_settings[ $option_name ] = $args;

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Gets the registered settings and their data.

[73] Fix | Delete

[74] Fix | Delete

* @return array Array of $option_name => $data pairs.

[75] Fix | Delete

[76] Fix | Delete

public function get_registered_settings() {

[77] Fix | Delete

return $this->registered_settings;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Gets the whitelisted options for a given option group.

[82] Fix | Delete

[83] Fix | Delete

* @param string $option_group Option group.

[84] Fix | Delete

[85] Fix | Delete

* @return array List of option names, or empty array if unknown option group.

[86] Fix | Delete

[87] Fix | Delete

public function get_whitelist_options( $option_group ) {

[88] Fix | Delete

if ( ! isset( $this->whitelist_options[ $option_group ] ) ) {

[89] Fix | Delete

return [];

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

return $this->whitelist_options[ $option_group ];

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Filters sanitization for a network option value.

[97] Fix | Delete

[98] Fix | Delete

* This method is added as a filter to `sanitize_option_{$option}` for network options that are

[99] Fix | Delete

* registered with a sanitize callback.

[100] Fix | Delete

[101] Fix | Delete

* @param string $value The sanitized option value.

[102] Fix | Delete

* @param string $option The option name.

[103] Fix | Delete

[104] Fix | Delete

* @return string The filtered sanitized option value.

[105] Fix | Delete

[106] Fix | Delete

public function filter_sanitize_option( $value, $option ) {

[107] Fix | Delete

[108] Fix | Delete

if ( empty( $this->registered_settings[ $option ] ) ) {

[109] Fix | Delete

return $value;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

return call_user_func( $this->registered_settings[ $option ]['sanitize_callback'], $value );

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Filters the default value for a network option.

[117] Fix | Delete

[118] Fix | Delete

* This function is added as a filter to `default_site_option_{$option}` for network options that

[119] Fix | Delete

* are registered with a default.

[120] Fix | Delete

[121] Fix | Delete

* @param mixed $default_value Existing default value to return.

[122] Fix | Delete

* @param string $option The option name.

[123] Fix | Delete

[124] Fix | Delete

* @return mixed The filtered default value.

[125] Fix | Delete

[126] Fix | Delete

public function filter_default_option( $default_value, $option ) {

[127] Fix | Delete

[128] Fix | Delete

// If a default value was manually passed to the function, allow it to override.

[129] Fix | Delete

if ( $default_value !== false ) {

[130] Fix | Delete

return $default_value;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

if ( empty( $this->registered_settings[ $option ] ) ) {

[134] Fix | Delete

return $default_value;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

return $this->registered_settings[ $option ]['default'];

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Checks whether the requirements to use this class are met.

[142] Fix | Delete

[143] Fix | Delete

* @return bool True if requirements are met, false otherwise.

[144] Fix | Delete

[145] Fix | Delete

public function meets_requirements() {

[146] Fix | Delete

return is_multisite();

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Gets the singleton instance of this class.

[151] Fix | Delete

[152] Fix | Delete

* @return Yoast_Network_Settings_API The singleton instance.

[153] Fix | Delete

[154] Fix | Delete

public static function get() {

[155] Fix | Delete

[156] Fix | Delete

if ( self::$instance === null ) {

[157] Fix | Delete

self::$instance = new self();

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

return self::$instance;

[161] Fix | Delete

}

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete