class-wp-customize-setting.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958
  1. <?php
  2. /**
  3. * WordPress Customize Setting classes
  4. *
  5. * @package WordPress
  6. * @subpackage Customize
  7. * @since 3.4.0
  8. */
  9. /**
  10. * Customize Setting class.
  11. *
  12. * Handles saving and sanitizing of settings.
  13. *
  14. * @since 3.4.0
  15. *
  16. * @see WP_Customize_Manager
  17. */
  18. class WP_Customize_Setting {
  19. /**
  20. * Customizer bootstrap instance.
  21. *
  22. * @since 3.4.0
  23. * @var WP_Customize_Manager
  24. */
  25. public $manager;
  26. /**
  27. * Unique string identifier for the setting.
  28. *
  29. * @since 3.4.0
  30. * @var string
  31. */
  32. public $id;
  33. /**
  34. * Type of customize settings.
  35. *
  36. * @since 3.4.0
  37. * @var string
  38. */
  39. public $type = 'theme_mod';
  40. /**
  41. * Capability required to edit this setting.
  42. *
  43. * @since 3.4.0
  44. * @var string|array
  45. */
  46. public $capability = 'edit_theme_options';
  47. /**
  48. * Feature a theme is required to support to enable this setting.
  49. *
  50. * @since 3.4.0
  51. * @var string
  52. */
  53. public $theme_supports = '';
  54. /**
  55. * The default value for the setting.
  56. *
  57. * @since 3.4.0
  58. * @var string
  59. */
  60. public $default = '';
  61. /**
  62. * Options for rendering the live preview of changes in Theme Customizer.
  63. *
  64. * Set this value to 'postMessage' to enable a custom Javascript handler to render changes to this setting
  65. * as opposed to reloading the whole page.
  66. *
  67. * @link https://developer.wordpress.org/themes/customize-api
  68. *
  69. * @since 3.4.0
  70. * @var string
  71. */
  72. public $transport = 'refresh';
  73. /**
  74. * Server-side validation callback for the setting's value.
  75. *
  76. * @since 4.6.0
  77. * @var callable
  78. */
  79. public $validate_callback = '';
  80. /**
  81. * Callback to filter a Customize setting value in un-slashed form.
  82. *
  83. * @since 3.4.0
  84. * @var callable
  85. */
  86. public $sanitize_callback = '';
  87. /**
  88. * Callback to convert a Customize PHP setting value to a value that is JSON serializable.
  89. *
  90. * @since 3.4.0
  91. * @var string
  92. */
  93. public $sanitize_js_callback = '';
  94. /**
  95. * Whether or not the setting is initially dirty when created.
  96. *
  97. * This is used to ensure that a setting will be sent from the pane to the
  98. * preview when loading the Customizer. Normally a setting only is synced to
  99. * the preview if it has been changed. This allows the setting to be sent
  100. * from the start.
  101. *
  102. * @since 4.2.0
  103. * @var bool
  104. */
  105. public $dirty = false;
  106. /**
  107. * ID Data.
  108. *
  109. * @since 3.4.0
  110. * @var array
  111. */
  112. protected $id_data = array();
  113. /**
  114. * Whether or not preview() was called.
  115. *
  116. * @since 4.4.0
  117. * @var bool
  118. */
  119. protected $is_previewed = false;
  120. /**
  121. * Cache of multidimensional values to improve performance.
  122. *
  123. * @since 4.4.0
  124. * @static
  125. * @var array
  126. */
  127. protected static $aggregated_multidimensionals = array();
  128. /**
  129. * Whether the multidimensional setting is aggregated.
  130. *
  131. * @since 4.4.0
  132. * @var bool
  133. */
  134. protected $is_multidimensional_aggregated = false;
  135. /**
  136. * Constructor.
  137. *
  138. * Any supplied $args override class property defaults.
  139. *
  140. * @since 3.4.0
  141. *
  142. * @param WP_Customize_Manager $manager
  143. * @param string $id An specific ID of the setting. Can be a
  144. * theme mod or option name.
  145. * @param array $args Setting arguments.
  146. */
  147. public function __construct( $manager, $id, $args = array() ) {
  148. $keys = array_keys( get_object_vars( $this ) );
  149. foreach ( $keys as $key ) {
  150. if ( isset( $args[ $key ] ) ) {
  151. $this->$key = $args[ $key ];
  152. }
  153. }
  154. $this->manager = $manager;
  155. $this->id = $id;
  156. // Parse the ID for array keys.
  157. $this->id_data['keys'] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );
  158. $this->id_data['base'] = array_shift( $this->id_data['keys'] );
  159. // Rebuild the ID.
  160. $this->id = $this->id_data[ 'base' ];
  161. if ( ! empty( $this->id_data[ 'keys' ] ) ) {
  162. $this->id .= '[' . implode( '][', $this->id_data['keys'] ) . ']';
  163. }
  164. if ( $this->validate_callback ) {
  165. add_filter( "customize_validate_{$this->id}", $this->validate_callback, 10, 3 );
  166. }
  167. if ( $this->sanitize_callback ) {
  168. add_filter( "customize_sanitize_{$this->id}", $this->sanitize_callback, 10, 2 );
  169. }
  170. if ( $this->sanitize_js_callback ) {
  171. add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
  172. }
  173. if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
  174. // Other setting types can opt-in to aggregate multidimensional explicitly.
  175. $this->aggregate_multidimensional();
  176. // Allow option settings to indicate whether they should be autoloaded.
  177. if ( 'option' === $this->type && isset( $args['autoload'] ) ) {
  178. self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] = $args['autoload'];
  179. }
  180. }
  181. }
  182. /**
  183. * Get parsed ID data for multidimensional setting.
  184. *
  185. * @since 4.4.0
  186. *
  187. * @return array {
  188. * ID data for multidimensional setting.
  189. *
  190. * @type string $base ID base
  191. * @type array $keys Keys for multidimensional array.
  192. * }
  193. */
  194. final public function id_data() {
  195. return $this->id_data;
  196. }
  197. /**
  198. * Set up the setting for aggregated multidimensional values.
  199. *
  200. * When a multidimensional setting gets aggregated, all of its preview and update
  201. * calls get combined into one call, greatly improving performance.
  202. *
  203. * @since 4.4.0
  204. */
  205. protected function aggregate_multidimensional() {
  206. $id_base = $this->id_data['base'];
  207. if ( ! isset( self::$aggregated_multidimensionals[ $this->type ] ) ) {
  208. self::$aggregated_multidimensionals[ $this->type ] = array();
  209. }
  210. if ( ! isset( self::$aggregated_multidimensionals[ $this->type ][ $id_base ] ) ) {
  211. self::$aggregated_multidimensionals[ $this->type ][ $id_base ] = array(
  212. 'previewed_instances' => array(), // Calling preview() will add the $setting to the array.
  213. 'preview_applied_instances' => array(), // Flags for which settings have had their values applied.
  214. 'root_value' => $this->get_root_value( array() ), // Root value for initial state, manipulated by preview and update calls.
  215. );
  216. }
  217. if ( ! empty( $this->id_data['keys'] ) ) {
  218. // Note the preview-applied flag is cleared at priority 9 to ensure it is cleared before a deferred-preview runs.
  219. add_action( "customize_post_value_set_{$this->id}", array( $this, '_clear_aggregated_multidimensional_preview_applied_flag' ), 9 );
  220. $this->is_multidimensional_aggregated = true;
  221. }
  222. }
  223. /**
  224. * Reset `$aggregated_multidimensionals` static variable.
  225. *
  226. * This is intended only for use by unit tests.
  227. *
  228. * @since 4.5.0
  229. * @ignore
  230. */
  231. static public function reset_aggregated_multidimensionals() {
  232. self::$aggregated_multidimensionals = array();
  233. }
  234. /**
  235. * The ID for the current site when the preview() method was called.
  236. *
  237. * @since 4.2.0
  238. * @var int
  239. */
  240. protected $_previewed_blog_id;
  241. /**
  242. * Return true if the current site is not the same as the previewed site.
  243. *
  244. * @since 4.2.0
  245. *
  246. * @return bool If preview() has been called.
  247. */
  248. public function is_current_blog_previewed() {
  249. if ( ! isset( $this->_previewed_blog_id ) ) {
  250. return false;
  251. }
  252. return ( get_current_blog_id() === $this->_previewed_blog_id );
  253. }
  254. /**
  255. * Original non-previewed value stored by the preview method.
  256. *
  257. * @see WP_Customize_Setting::preview()
  258. * @since 4.1.1
  259. * @var mixed
  260. */
  261. protected $_original_value;
  262. /**
  263. * Add filters to supply the setting's value when accessed.
  264. *
  265. * If the setting already has a pre-existing value and there is no incoming
  266. * post value for the setting, then this method will short-circuit since
  267. * there is no change to preview.
  268. *
  269. * @since 3.4.0
  270. * @since 4.4.0 Added boolean return value.
  271. *
  272. * @return bool False when preview short-circuits due no change needing to be previewed.
  273. */
  274. public function preview() {
  275. if ( ! isset( $this->_previewed_blog_id ) ) {
  276. $this->_previewed_blog_id = get_current_blog_id();
  277. }
  278. // Prevent re-previewing an already-previewed setting.
  279. if ( $this->is_previewed ) {
  280. return true;
  281. }
  282. $id_base = $this->id_data['base'];
  283. $is_multidimensional = ! empty( $this->id_data['keys'] );
  284. $multidimensional_filter = array( $this, '_multidimensional_preview_filter' );
  285. /*
  286. * Check if the setting has a pre-existing value (an isset check),
  287. * and if doesn't have any incoming post value. If both checks are true,
  288. * then the preview short-circuits because there is nothing that needs
  289. * to be previewed.
  290. */
  291. $undefined = new stdClass();
  292. $needs_preview = ( $undefined !== $this->post_value( $undefined ) );
  293. $value = null;
  294. // Since no post value was defined, check if we have an initial value set.
  295. if ( ! $needs_preview ) {
  296. if ( $this->is_multidimensional_aggregated ) {
  297. $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
  298. $value = $this->multidimensional_get( $root, $this->id_data['keys'], $undefined );
  299. } else {
  300. $default = $this->default;
  301. $this->default = $undefined; // Temporarily set default to undefined so we can detect if existing value is set.
  302. $value = $this->value();
  303. $this->default = $default;
  304. }
  305. $needs_preview = ( $undefined === $value ); // Because the default needs to be supplied.
  306. }
  307. // If the setting does not need previewing now, defer to when it has a value to preview.
  308. if ( ! $needs_preview ) {
  309. if ( ! has_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) ) ) {
  310. add_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) );
  311. }
  312. return false;
  313. }
  314. switch ( $this->type ) {
  315. case 'theme_mod' :
  316. if ( ! $is_multidimensional ) {
  317. add_filter( "theme_mod_{$id_base}", array( $this, '_preview_filter' ) );
  318. } else {
  319. if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
  320. // Only add this filter once for this ID base.
  321. add_filter( "theme_mod_{$id_base}", $multidimensional_filter );
  322. }
  323. self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
  324. }
  325. break;
  326. case 'option' :
  327. if ( ! $is_multidimensional ) {
  328. add_filter( "pre_option_{$id_base}", array( $this, '_preview_filter' ) );
  329. } else {
  330. if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
  331. // Only add these filters once for this ID base.
  332. add_filter( "option_{$id_base}", $multidimensional_filter );
  333. add_filter( "default_option_{$id_base}", $multidimensional_filter );
  334. }
  335. self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
  336. }
  337. break;
  338. default :
  339. /**
  340. * Fires when the WP_Customize_Setting::preview() method is called for settings
  341. * not handled as theme_mods or options.
  342. *
  343. * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
  344. *
  345. * @since 3.4.0
  346. *
  347. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  348. */
  349. do_action( "customize_preview_{$this->id}", $this );
  350. /**
  351. * Fires when the WP_Customize_Setting::preview() method is called for settings
  352. * not handled as theme_mods or options.
  353. *
  354. * The dynamic portion of the hook name, `$this->type`, refers to the setting type.
  355. *
  356. * @since 4.1.0
  357. *
  358. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  359. */
  360. do_action( "customize_preview_{$this->type}", $this );
  361. }
  362. $this->is_previewed = true;
  363. return true;
  364. }
  365. /**
  366. * Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
  367. *
  368. * This ensures that the new value will get sanitized and used the next time
  369. * that `WP_Customize_Setting::_multidimensional_preview_filter()`
  370. * is called for this setting.
  371. *
  372. * @since 4.4.0
  373. *
  374. * @see WP_Customize_Manager::set_post_value()
  375. * @see WP_Customize_Setting::_multidimensional_preview_filter()
  376. */
  377. final public function _clear_aggregated_multidimensional_preview_applied_flag() {
  378. unset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['preview_applied_instances'][ $this->id ] );
  379. }
  380. /**
  381. * Callback function to filter non-multidimensional theme mods and options.
  382. *
  383. * If switch_to_blog() was called after the preview() method, and the current
  384. * site is now not the same site, then this method does a no-op and returns
  385. * the original value.
  386. *
  387. * @since 3.4.0
  388. *
  389. * @param mixed $original Old value.
  390. * @return mixed New or old value.
  391. */
  392. public function _preview_filter( $original ) {
  393. if ( ! $this->is_current_blog_previewed() ) {
  394. return $original;
  395. }
  396. $undefined = new stdClass(); // Symbol hack.
  397. $post_value = $this->post_value( $undefined );
  398. if ( $undefined !== $post_value ) {
  399. $value = $post_value;
  400. } else {
  401. /*
  402. * Note that we don't use $original here because preview() will
  403. * not add the filter in the first place if it has an initial value
  404. * and there is no post value.
  405. */
  406. $value = $this->default;
  407. }
  408. return $value;
  409. }
  410. /**
  411. * Callback function to filter multidimensional theme mods and options.
  412. *
  413. * For all multidimensional settings of a given type, the preview filter for
  414. * the first setting previewed will be used to apply the values for the others.
  415. *
  416. * @since 4.4.0
  417. *
  418. * @see WP_Customize_Setting::$aggregated_multidimensionals
  419. * @param mixed $original Original root value.
  420. * @return mixed New or old value.
  421. */
  422. final public function _multidimensional_preview_filter( $original ) {
  423. if ( ! $this->is_current_blog_previewed() ) {
  424. return $original;
  425. }
  426. $id_base = $this->id_data['base'];
  427. // If no settings have been previewed yet (which should not be the case, since $this is), just pass through the original value.
  428. if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
  429. return $original;
  430. }
  431. foreach ( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] as $previewed_setting ) {
  432. // Skip applying previewed value for any settings that have already been applied.
  433. if ( ! empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] ) ) {
  434. continue;
  435. }
  436. // Do the replacements of the posted/default sub value into the root value.
  437. $value = $previewed_setting->post_value( $previewed_setting->default );
  438. $root = self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'];
  439. $root = $previewed_setting->multidimensional_replace( $root, $previewed_setting->id_data['keys'], $value );
  440. self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'] = $root;
  441. // Mark this setting having been applied so that it will be skipped when the filter is called again.
  442. self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] = true;
  443. }
  444. return self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
  445. }
  446. /**
  447. * Checks user capabilities and theme supports, and then saves
  448. * the value of the setting.
  449. *
  450. * @since 3.4.0
  451. *
  452. * @return false|void False if cap check fails or value isn't set or is invalid.
  453. */
  454. final public function save() {
  455. $value = $this->post_value();
  456. if ( ! $this->check_capabilities() || ! isset( $value ) ) {
  457. return false;
  458. }
  459. $id_base = $this->id_data['base'];
  460. /**
  461. * Fires when the WP_Customize_Setting::save() method is called.
  462. *
  463. * The dynamic portion of the hook name, `$id_base` refers to
  464. * the base slug of the setting name.
  465. *
  466. * @since 3.4.0
  467. *
  468. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  469. */
  470. do_action( "customize_save_{$id_base}", $this );
  471. $this->update( $value );
  472. }
  473. /**
  474. * Fetch and sanitize the $_POST value for the setting.
  475. *
  476. * During a save request prior to save, post_value() provides the new value while value() does not.
  477. *
  478. * @since 3.4.0
  479. *
  480. * @param mixed $default A default value which is used as a fallback. Default is null.
  481. * @return mixed The default value on failure, otherwise the sanitized and validated value.
  482. */
  483. final public function post_value( $default = null ) {
  484. return $this->manager->post_value( $this, $default );
  485. }
  486. /**
  487. * Sanitize an input.
  488. *
  489. * @since 3.4.0
  490. *
  491. * @param string|array $value The value to sanitize.
  492. * @return string|array|null|WP_Error Sanitized value, or `null`/`WP_Error` if invalid.
  493. */
  494. public function sanitize( $value ) {
  495. /**
  496. * Filters a Customize setting value in un-slashed form.
  497. *
  498. * @since 3.4.0
  499. *
  500. * @param mixed $value Value of the setting.
  501. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  502. */
  503. return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
  504. }
  505. /**
  506. * Validates an input.
  507. *
  508. * @since 4.6.0
  509. *
  510. * @see WP_REST_Request::has_valid_params()
  511. *
  512. * @param mixed $value Value to validate.
  513. * @return true|WP_Error True if the input was validated, otherwise WP_Error.
  514. */
  515. public function validate( $value ) {
  516. if ( is_wp_error( $value ) ) {
  517. return $value;
  518. }
  519. if ( is_null( $value ) ) {
  520. return new WP_Error( 'invalid_value', __( 'Invalid value.' ) );
  521. }
  522. $validity = new WP_Error();
  523. /**
  524. * Validates a Customize setting value.
  525. *
  526. * Plugins should amend the `$validity` object via its `WP_Error::add()` method.
  527. *
  528. * The dynamic portion of the hook name, `$this->ID`, refers to the setting ID.
  529. *
  530. * @since 4.6.0
  531. *
  532. * @param WP_Error $validity Filtered from `true` to `WP_Error` when invalid.
  533. * @param mixed $value Value of the setting.
  534. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  535. */
  536. $validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this );
  537. if ( is_wp_error( $validity ) && empty( $validity->errors ) ) {
  538. $validity = true;
  539. }
  540. return $validity;
  541. }
  542. /**
  543. * Get the root value for a setting, especially for multidimensional ones.
  544. *
  545. * @since 4.4.0
  546. *
  547. * @param mixed $default Value to return if root does not exist.
  548. * @return mixed
  549. */
  550. protected function get_root_value( $default = null ) {
  551. $id_base = $this->id_data['base'];
  552. if ( 'option' === $this->type ) {
  553. return get_option( $id_base, $default );
  554. } elseif ( 'theme_mod' === $this->type ) {
  555. return get_theme_mod( $id_base, $default );
  556. } else {
  557. /*
  558. * Any WP_Customize_Setting subclass implementing aggregate multidimensional
  559. * will need to override this method to obtain the data from the appropriate
  560. * location.
  561. */
  562. return $default;
  563. }
  564. }
  565. /**
  566. * Set the root value for a setting, especially for multidimensional ones.
  567. *
  568. * @since 4.4.0
  569. *
  570. * @param mixed $value Value to set as root of multidimensional setting.
  571. * @return bool Whether the multidimensional root was updated successfully.
  572. */
  573. protected function set_root_value( $value ) {
  574. $id_base = $this->id_data['base'];
  575. if ( 'option' === $this->type ) {
  576. $autoload = true;
  577. if ( isset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] ) ) {
  578. $autoload = self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'];
  579. }
  580. return update_option( $id_base, $value, $autoload );
  581. } elseif ( 'theme_mod' === $this->type ) {
  582. set_theme_mod( $id_base, $value );
  583. return true;
  584. } else {
  585. /*
  586. * Any WP_Customize_Setting subclass implementing aggregate multidimensional
  587. * will need to override this method to obtain the data from the appropriate
  588. * location.
  589. */
  590. return false;
  591. }
  592. }
  593. /**
  594. * Save the value of the setting, using the related API.
  595. *
  596. * @since 3.4.0
  597. *
  598. * @param mixed $value The value to update.
  599. * @return bool The result of saving the value.
  600. */
  601. protected function update( $value ) {
  602. $id_base = $this->id_data['base'];
  603. if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
  604. if ( ! $this->is_multidimensional_aggregated ) {
  605. return $this->set_root_value( $value );
  606. } else {
  607. $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
  608. $root = $this->multidimensional_replace( $root, $this->id_data['keys'], $value );
  609. self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'] = $root;
  610. return $this->set_root_value( $root );
  611. }
  612. } else {
  613. /**
  614. * Fires when the WP_Customize_Setting::update() method is called for settings
  615. * not handled as theme_mods or options.
  616. *
  617. * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
  618. *
  619. * @since 3.4.0
  620. *
  621. * @param mixed $value Value of the setting.
  622. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  623. */
  624. do_action( "customize_update_{$this->type}", $value, $this );
  625. return has_action( "customize_update_{$this->type}" );
  626. }
  627. }
  628. /**
  629. * Deprecated method.
  630. *
  631. * @since 3.4.0
  632. * @deprecated 4.4.0 Deprecated in favor of update() method.
  633. */
  634. protected function _update_theme_mod() {
  635. _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
  636. }
  637. /**
  638. * Deprecated method.
  639. *
  640. * @since 3.4.0
  641. * @deprecated 4.4.0 Deprecated in favor of update() method.
  642. */
  643. protected function _update_option() {
  644. _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
  645. }
  646. /**
  647. * Fetch the value of the setting.
  648. *
  649. * @since 3.4.0
  650. *
  651. * @return mixed The value.
  652. */
  653. public function value() {
  654. $id_base = $this->id_data['base'];
  655. $is_core_type = ( 'option' === $this->type || 'theme_mod' === $this->type );
  656. if ( ! $is_core_type && ! $this->is_multidimensional_aggregated ) {
  657. // Use post value if previewed and a post value is present.
  658. if ( $this->is_previewed ) {
  659. $value = $this->post_value( null );
  660. if ( null !== $value ) {
  661. return $value;
  662. }
  663. }
  664. $value = $this->get_root_value( $this->default );
  665. /**
  666. * Filters a Customize setting value not handled as a theme_mod or option.
  667. *
  668. * The dynamic portion of the hook name, `$id_base`, refers to
  669. * the base slug of the setting name, initialized from `$this->id_data['base']`.
  670. *
  671. * For settings handled as theme_mods or options, see those corresponding
  672. * functions for available hooks.
  673. *
  674. * @since 3.4.0
  675. * @since 4.6.0 Added the `$this` setting instance as the second parameter.
  676. *
  677. * @param mixed $default The setting default value. Default empty.
  678. * @param WP_Customize_Setting $this The setting instance.
  679. */
  680. $value = apply_filters( "customize_value_{$id_base}", $value, $this );
  681. } elseif ( $this->is_multidimensional_aggregated ) {
  682. $root_value = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
  683. $value = $this->multidimensional_get( $root_value, $this->id_data['keys'], $this->default );
  684. // Ensure that the post value is used if the setting is previewed, since preview filters aren't applying on cached $root_value.
  685. if ( $this->is_previewed ) {
  686. $value = $this->post_value( $value );
  687. }
  688. } else {
  689. $value = $this->get_root_value( $this->default );
  690. }
  691. return $value;
  692. }
  693. /**
  694. * Sanitize the setting's value for use in JavaScript.
  695. *
  696. * @since 3.4.0
  697. *
  698. * @return mixed The requested escaped value.
  699. */
  700. public function js_value() {
  701. /**
  702. * Filters a Customize setting value for use in JavaScript.
  703. *
  704. * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
  705. *
  706. * @since 3.4.0
  707. *
  708. * @param mixed $value The setting value.
  709. * @param WP_Customize_Setting $this WP_Customize_Setting instance.
  710. */
  711. $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
  712. if ( is_string( $value ) )
  713. return html_entity_decode( $value, ENT_QUOTES, 'UTF-8');
  714. return $value;
  715. }
  716. /**
  717. * Retrieves the data to export to the client via JSON.
  718. *
  719. * @since 4.6.0
  720. *
  721. * @return array Array of parameters passed to JavaScript.
  722. */
  723. public function json() {
  724. return array(
  725. 'value' => $this->js_value(),
  726. 'transport' => $this->transport,
  727. 'dirty' => $this->dirty,
  728. 'type' => $this->type,
  729. );
  730. }
  731. /**
  732. * Validate user capabilities whether the theme supports the setting.
  733. *
  734. * @since 3.4.0
  735. *
  736. * @return bool False if theme doesn't support the setting or user can't change setting, otherwise true.
  737. */
  738. final public function check_capabilities() {
  739. if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) )
  740. return false;
  741. if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) )
  742. return false;
  743. return true;
  744. }
  745. /**
  746. * Multidimensional helper function.
  747. *
  748. * @since 3.4.0
  749. *
  750. * @param $root
  751. * @param $keys
  752. * @param bool $create Default is false.
  753. * @return array|void Keys are 'root', 'node', and 'key'.
  754. */
  755. final protected function multidimensional( &$root, $keys, $create = false ) {
  756. if ( $create && empty( $root ) )
  757. $root = array();
  758. if ( ! isset( $root ) || empty( $keys ) )
  759. return;
  760. $last = array_pop( $keys );
  761. $node = &$root;
  762. foreach ( $keys as $key ) {
  763. if ( $create && ! isset( $node[ $key ] ) )
  764. $node[ $key ] = array();
  765. if ( ! is_array( $node ) || ! isset( $node[ $key ] ) )
  766. return;
  767. $node = &$node[ $key ];
  768. }
  769. if ( $create ) {
  770. if ( ! is_array( $node ) ) {
  771. // account for an array overriding a string or object value
  772. $node = array();
  773. }
  774. if ( ! isset( $node[ $last ] ) ) {
  775. $node[ $last ] = array();
  776. }
  777. }
  778. if ( ! isset( $node[ $last ] ) )
  779. return;
  780. return array(
  781. 'root' => &$root,
  782. 'node' => &$node,
  783. 'key' => $last,
  784. );
  785. }
  786. /**
  787. * Will attempt to replace a specific value in a multidimensional array.
  788. *
  789. * @since 3.4.0
  790. *
  791. * @param $root
  792. * @param $keys
  793. * @param mixed $value The value to update.
  794. * @return mixed
  795. */
  796. final protected function multidimensional_replace( $root, $keys, $value ) {
  797. if ( ! isset( $value ) )
  798. return $root;
  799. elseif ( empty( $keys ) ) // If there are no keys, we're replacing the root.
  800. return $value;
  801. $result = $this->multidimensional( $root, $keys, true );
  802. if ( isset( $result ) )
  803. $result['node'][ $result['key'] ] = $value;
  804. return $root;
  805. }
  806. /**
  807. * Will attempt to fetch a specific value from a multidimensional array.
  808. *
  809. * @since 3.4.0
  810. *
  811. * @param $root
  812. * @param $keys
  813. * @param mixed $default A default value which is used as a fallback. Default is null.
  814. * @return mixed The requested value or the default value.
  815. */
  816. final protected function multidimensional_get( $root, $keys, $default = null ) {
  817. if ( empty( $keys ) ) // If there are no keys, test the root.
  818. return isset( $root ) ? $root : $default;
  819. $result = $this->multidimensional( $root, $keys );
  820. return isset( $result ) ? $result['node'][ $result['key'] ] : $default;
  821. }
  822. /**
  823. * Will attempt to check if a specific value in a multidimensional array is set.
  824. *
  825. * @since 3.4.0
  826. *
  827. * @param $root
  828. * @param $keys
  829. * @return bool True if value is set, false if not.
  830. */
  831. final protected function multidimensional_isset( $root, $keys ) {
  832. $result = $this->multidimensional_get( $root, $keys );
  833. return isset( $result );
  834. }
  835. }
  836. /**
  837. * WP_Customize_Filter_Setting class.
  838. */
  839. require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' );
  840. /**
  841. * WP_Customize_Header_Image_Setting class.
  842. */
  843. require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' );
  844. /**
  845. * WP_Customize_Background_Image_Setting class.
  846. */
  847. require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' );
  848. /**
  849. * WP_Customize_Nav_Menu_Item_Setting class.
  850. */
  851. require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' );
  852. /**
  853. * WP_Customize_Nav_Menu_Setting class.
  854. */
  855. require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' );