2012-02-24 23:12:43 -05:00
< ? php
/**
2015-02-25 03:07:24 -05:00
* WordPress Customize Manager classes
*
* @ package WordPress
* @ subpackage Customize
* @ since 3.4 . 0
*/
/**
* Customize Manager class .
2012-02-24 23:12:43 -05:00
*
2014-03-04 15:21:14 -05:00
* Bootstraps the Customize experience on the server - side .
*
* Sets up the theme - switching process if a theme other than the active one is
* being previewed and customized .
*
* Serves as a factory for Customize Controls and Settings , and
* instantiates default Customize Controls and Settings .
*
2012-02-24 23:12:43 -05:00
* @ since 3.4 . 0
*/
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
There are a number of ways to mitigate this:
* If it is an accidental typo for a declared property: fix the typo.
* For known properties: declare them on the class.
* For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in.
* For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes.
Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1.
To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP.
The logic used for this commit is as follows:
* If a class already has the attribute: no action needed.
* If a class does not `extend`: add the attribute.
* If a class does `extend`:
- If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties).
- If it extends a PHP native class: add the attribute.
- If it extends a class from one of WP's external dependencies: add the attribute.
* In all other cases: no action — the attribute should not be needed as child classes inherit from the parent.
Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details.
This commit only affects classes in the `src` directory of WordPress core.
* Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033.
* While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [53922].
Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath.
See #56513, #56034.
Built from https://develop.svn.wordpress.org/trunk@54133
git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-12 11:47:14 -04:00
#[AllowDynamicProperties]
2012-05-23 13:56:42 -04:00
final class WP_Customize_Manager {
2014-03-04 15:21:14 -05:00
/**
2014-08-08 19:31:15 -04:00
* An instance of the theme being previewed .
2014-03-04 15:21:14 -05:00
*
2015-09-19 02:40:26 -04:00
* @ since 3.4 . 0
2014-03-04 15:21:14 -05:00
* @ var WP_Theme
*/
2012-04-17 17:43:47 -04:00
protected $theme ;
2014-03-04 15:21:14 -05:00
/**
* The directory name of the previously active theme ( within the theme_root ) .
*
2015-09-19 02:40:26 -04:00
* @ since 3.4 . 0
2014-03-04 15:21:14 -05:00
* @ var string
*/
2012-04-17 16:49:39 -04:00
protected $original_stylesheet ;
2014-03-04 15:21:14 -05:00
/**
2014-08-08 19:31:15 -04:00
* Whether this is a Customizer pageload .
2014-03-04 15:21:14 -05:00
*
2015-09-19 02:40:26 -04:00
* @ since 3.4 . 0
2015-06-26 21:03:25 -04:00
* @ var bool
2014-03-04 15:21:14 -05:00
*/
2012-02-24 23:12:43 -05:00
protected $previewing = false ;
2014-03-28 10:07:14 -04:00
/**
2015-09-19 02:40:26 -04:00
* Methods and properties dealing with managing widgets in the Customizer .
2014-03-28 10:07:14 -04:00
*
2015-09-19 02:40:26 -04:00
* @ since 3.9 . 0
2014-03-28 10:07:14 -04:00
* @ var WP_Customize_Widgets
*/
public $widgets ;
Add menu management to the Customizer.
This brings in the Menu Customizer plugin: https://wordpress.org/plugins/menu-customizer/.
props celloexpressions, westonruter, valendesigns, voldemortensen, ocean90, adamsilverstein, kucrut, jorbin, designsimply, afercia, davidakennedy, obenland.
see #32576.
Built from https://develop.svn.wordpress.org/trunk@32806
git-svn-id: http://core.svn.wordpress.org/trunk@32777 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-16 18:08:26 -04:00
/**
2015-09-19 02:40:26 -04:00
* Methods and properties dealing with managing nav menus in the Customizer .
Add menu management to the Customizer.
This brings in the Menu Customizer plugin: https://wordpress.org/plugins/menu-customizer/.
props celloexpressions, westonruter, valendesigns, voldemortensen, ocean90, adamsilverstein, kucrut, jorbin, designsimply, afercia, davidakennedy, obenland.
see #32576.
Built from https://develop.svn.wordpress.org/trunk@32806
git-svn-id: http://core.svn.wordpress.org/trunk@32777 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-16 18:08:26 -04:00
*
2015-09-19 02:40:26 -04:00
* @ since 4.3 . 0
Add menu management to the Customizer.
This brings in the Menu Customizer plugin: https://wordpress.org/plugins/menu-customizer/.
props celloexpressions, westonruter, valendesigns, voldemortensen, ocean90, adamsilverstein, kucrut, jorbin, designsimply, afercia, davidakennedy, obenland.
see #32576.
Built from https://develop.svn.wordpress.org/trunk@32806
git-svn-id: http://core.svn.wordpress.org/trunk@32777 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-16 18:08:26 -04:00
* @ var WP_Customize_Nav_Menus
*/
public $nav_menus ;
2016-02-19 13:41:28 -05:00
/**
* Methods and properties dealing with selective refresh in the Customizer preview .
*
* @ since 4.5 . 0
* @ var WP_Customize_Selective_Refresh
*/
public $selective_refresh ;
2015-09-19 02:40:26 -04:00
/**
* Registered instances of WP_Customize_Setting .
*
* @ since 3.4 . 0
* @ var array
*/
protected $settings = array ();
/**
* Sorted top - level instances of WP_Customize_Panel and WP_Customize_Section .
*
* @ since 4.0 . 0
* @ var array
*/
2014-08-14 00:43:16 -04:00
protected $containers = array ();
2012-02-24 23:12:43 -05:00
2015-09-19 02:40:26 -04:00
/**
* Registered instances of WP_Customize_Panel .
*
* @ since 4.0 . 0
* @ var array
*/
protected $panels = array ();
2012-06-26 14:48:18 -04:00
2016-01-11 15:28:28 -05:00
/**
* List of core components .
*
* @ since 4.5 . 0
* @ var array
*/
2024-06-10 18:12:17 -04:00
protected $components = array ( 'nav_menus' );
2016-01-11 15:28:28 -05:00
2015-09-19 02:40:26 -04:00
/**
* Registered instances of WP_Customize_Section .
*
* @ since 3.4 . 0
* @ var array
*/
protected $sections = array ();
/**
* Registered instances of WP_Customize_Control .
*
* @ since 3.4 . 0
* @ var array
*/
protected $controls = array ();
2014-03-04 15:21:14 -05:00
/**
2015-05-29 20:03:30 -04:00
* Panel types that may be rendered from JS templates .
*
* @ since 4.3 . 0
* @ var array
*/
protected $registered_panel_types = array ();
/**
* Section types that may be rendered from JS templates .
*
* @ since 4.3 . 0
* @ var array
*/
protected $registered_section_types = array ();
/**
* Control types that may be rendered from JS templates .
2014-10-24 12:32:18 -04:00
*
* @ since 4.1 . 0
2014-11-28 05:52:22 -05:00
* @ var array
2014-10-24 12:32:18 -04:00
*/
protected $registered_control_types = array ();
2015-09-17 15:42:26 -04:00
/**
* Initial URL being previewed .
*
* @ since 4.4 . 0
* @ var string
*/
protected $preview_url ;
/**
* URL to link the user to when closing the Customizer .
*
* @ since 4.4 . 0
* @ var string
*/
protected $return_url ;
/**
* Mapping of 'panel' , 'section' , 'control' to the ID which should be autofocused .
*
* @ since 4.4 . 0
2021-12-07 07:20:02 -05:00
* @ var string []
2015-09-17 15:42:26 -04:00
*/
protected $autofocus = array ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
* Messenger channel .
*
* @ since 4.7 . 0
* @ var string
*/
protected $messenger_channel ;
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
/**
2017-10-12 00:01:46 -04:00
* Whether the autosave revision of the changeset should be loaded .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*
* @ since 4.9 . 0
* @ var bool
*/
protected $autosaved = false ;
/**
* Whether the changeset branching is allowed .
*
* @ since 4.9 . 0
* @ var bool
*/
protected $branching = true ;
2017-08-02 01:35:41 -04:00
/**
* Whether settings should be previewed .
*
* @ since 4.9 . 0
* @ var bool
*/
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
protected $settings_previewed = true ;
/**
* Whether a starter content changeset was saved .
*
* @ since 4.9 . 0
* @ var bool
*/
protected $saved_starter_content_changeset = false ;
2017-08-02 01:35:41 -04:00
2014-11-30 18:33:23 -05:00
/**
2015-02-03 05:15:21 -05:00
* Unsanitized values for Customize Settings parsed from $_POST [ 'customized' ] .
2014-03-04 15:21:14 -05:00
*
2015-02-08 18:11:25 -05:00
* @ var array
2014-03-04 15:21:14 -05:00
*/
2012-04-30 11:46:17 -04:00
private $_post_values ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
* Changeset UUID .
*
* @ since 4.7 . 0
* @ var string
*/
private $_changeset_uuid ;
/**
* Changeset post ID .
*
* @ since 4.7 . 0
* @ var int | false
*/
private $_changeset_post_id ;
/**
* Changeset data loaded from a customize_changeset post .
*
* @ since 4.7 . 0
2019-05-25 22:07:53 -04:00
* @ var array | null
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*/
private $_changeset_data ;
2012-02-24 23:12:43 -05:00
/**
* Constructor .
*
* @ since 3.4 . 0
2018-02-09 11:55:31 -05:00
* @ since 4.7 . 0 Added `$args` parameter .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ param array $args {
* Args .
*
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
* @ type null | string | false $changeset_uuid Changeset UUID , the `post_name` for the customize_changeset post containing the customized state .
* Defaults to `null` resulting in a UUID to be immediately generated . If `false` is provided , then
* then the changeset UUID will be determined during `after_setup_theme` : when the
* `customize_changeset_branching` filter returns false , then the default UUID will be that
* of the most recent `customize_changeset` post that has a status other than 'auto-draft' ,
* 'publish' , or 'trash' . Otherwise , if changeset branching is enabled , then a random UUID will be used .
* @ type string $theme Theme to be previewed ( for theme switch ) . Defaults to customize_theme or theme query params .
* @ type string $messenger_channel Messenger channel . Defaults to customize_messenger_channel query param .
* @ type bool $settings_previewed If settings should be previewed . Defaults to true .
* @ type bool $branching If changeset branching is allowed ; otherwise , changesets are linear . Defaults to true .
* @ type bool $autosaved If data from a changeset ' s autosaved revision should be loaded if it exists . Defaults to false .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* }
2012-02-24 23:12:43 -05:00
*/
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
public function __construct ( $args = array () ) {
$args = array_merge (
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
array_fill_keys ( array ( 'changeset_uuid' , 'theme' , 'messenger_channel' , 'settings_previewed' , 'autosaved' , 'branching' ), null ),
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$args
);
// Note that the UUID format will be validated in the setup_theme() method.
if ( ! isset ( $args [ 'changeset_uuid' ] ) ) {
$args [ 'changeset_uuid' ] = wp_generate_uuid4 ();
}
2023-07-09 16:17:29 -04:00
/*
* The theme and messenger_channel should be supplied via $args ,
* but they are also looked at in the $_REQUEST global here for back - compat .
*/
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! isset ( $args [ 'theme' ] ) ) {
if ( isset ( $_REQUEST [ 'customize_theme' ] ) ) {
$args [ 'theme' ] = wp_unslash ( $_REQUEST [ 'customize_theme' ] );
} elseif ( isset ( $_REQUEST [ 'theme' ] ) ) { // Deprecated.
$args [ 'theme' ] = wp_unslash ( $_REQUEST [ 'theme' ] );
}
}
if ( ! isset ( $args [ 'messenger_channel' ] ) && isset ( $_REQUEST [ 'customize_messenger_channel' ] ) ) {
$args [ 'messenger_channel' ] = sanitize_key ( wp_unslash ( $_REQUEST [ 'customize_messenger_channel' ] ) );
}
2024-06-10 18:12:17 -04:00
// Do not load 'widgets' component if a block theme is activated.
if ( ! wp_is_block_theme () ) {
$this -> components [] = 'widgets' ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> original_stylesheet = get_stylesheet ();
2017-11-30 18:11:00 -05:00
$this -> theme = wp_get_theme ( 0 === validate_file ( $args [ 'theme' ] ) ? $args [ 'theme' ] : null );
$this -> messenger_channel = $args [ 'messenger_channel' ];
$this -> _changeset_uuid = $args [ 'changeset_uuid' ];
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
foreach ( array ( 'settings_previewed' , 'autosaved' , 'branching' ) as $key ) {
if ( isset ( $args [ $key ] ) ) {
$this -> $key = ( bool ) $args [ $key ];
}
}
2020-02-06 01:33:11 -05:00
require_once ABSPATH . WPINC . '/class-wp-customize-setting.php' ;
require_once ABSPATH . WPINC . '/class-wp-customize-panel.php' ;
require_once ABSPATH . WPINC . '/class-wp-customize-section.php' ;
require_once ABSPATH . WPINC . '/class-wp-customize-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-code-editor-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-locations-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menus-panel.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-themes-panel.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-custom-css-setting.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' ;
require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' ;
2016-08-31 12:31:29 -04:00
2015-10-20 18:16:25 -04:00
/**
2016-05-22 14:10:29 -04:00
* Filters the core Customizer components to load .
2015-10-20 18:16:25 -04:00
*
* This allows Core components to be excluded from being instantiated by
* filtering them out of the array . Note that this filter generally runs
2016-02-24 11:44:26 -05:00
* during the { @ see 'plugins_loaded' } action , so it cannot be added
2015-10-20 18:16:25 -04:00
* in a theme .
*
* @ since 4.4 . 0
*
* @ see WP_Customize_Manager :: __construct ()
*
2018-03-25 14:10:32 -04:00
* @ param string [] $components Array of core components to load .
2021-12-10 15:30:05 -05:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2015-10-20 18:16:25 -04:00
*/
2016-01-11 15:28:28 -05:00
$components = apply_filters ( 'customize_loaded_components' , $this -> components , $this );
2015-10-20 18:16:25 -04:00
2020-02-06 01:33:11 -05:00
require_once ABSPATH . WPINC . '/customize/class-wp-customize-selective-refresh.php' ;
2016-03-21 17:59:29 -04:00
$this -> selective_refresh = new WP_Customize_Selective_Refresh ( $this );
2016-02-19 13:41:28 -05:00
if ( in_array ( 'widgets' , $components , true ) ) {
2020-02-06 01:33:11 -05:00
require_once ABSPATH . WPINC . '/class-wp-customize-widgets.php' ;
2015-10-20 18:16:25 -04:00
$this -> widgets = new WP_Customize_Widgets ( $this );
}
2016-02-19 13:41:28 -05:00
if ( in_array ( 'nav_menus' , $components , true ) ) {
2020-02-06 01:33:11 -05:00
require_once ABSPATH . WPINC . '/class-wp-customize-nav-menus.php' ;
2015-10-20 18:16:25 -04:00
$this -> nav_menus = new WP_Customize_Nav_Menus ( $this );
}
2012-02-24 23:12:43 -05:00
2015-04-06 11:10:27 -04:00
add_action ( 'setup_theme' , array ( $this , 'setup_theme' ) );
2017-11-30 18:11:00 -05:00
add_action ( 'wp_loaded' , array ( $this , 'wp_loaded' ) );
2012-02-24 23:12:43 -05:00
2014-10-15 13:21:19 -04:00
// Do not spawn cron (especially the alternate cron) while running the Customizer.
2012-05-25 23:52:14 -04:00
remove_action ( 'init' , 'wp_cron' );
// Do not run update checks when rendering the controls.
remove_action ( 'admin_init' , '_maybe_update_core' );
remove_action ( 'admin_init' , '_maybe_update_plugins' );
remove_action ( 'admin_init' , '_maybe_update_themes' );
2017-11-30 18:11:00 -05:00
add_action ( 'wp_ajax_customize_save' , array ( $this , 'save' ) );
add_action ( 'wp_ajax_customize_trash' , array ( $this , 'handle_changeset_trash_request' ) );
add_action ( 'wp_ajax_customize_refresh_nonces' , array ( $this , 'refresh_nonces' ) );
add_action ( 'wp_ajax_customize_load_themes' , array ( $this , 'handle_load_themes_request' ) );
add_filter ( 'heartbeat_settings' , array ( $this , 'add_customize_screen_to_heartbeat_settings' ) );
add_filter ( 'heartbeat_received' , array ( $this , 'check_changeset_lock_with_heartbeat' ), 10 , 3 );
add_action ( 'wp_ajax_customize_override_changeset_lock' , array ( $this , 'handle_override_changeset_lock_request' ) );
2017-10-12 00:01:46 -04:00
add_action ( 'wp_ajax_customize_dismiss_autosave_or_lock' , array ( $this , 'handle_dismiss_autosave_or_lock_request' ) );
2012-04-30 11:46:17 -04:00
2017-11-30 18:11:00 -05:00
add_action ( 'customize_register' , array ( $this , 'register_controls' ) );
2020-01-28 19:45:18 -05:00
add_action ( 'customize_register' , array ( $this , 'register_dynamic_settings' ), 11 ); // Allow code to create settings first.
2017-11-30 18:11:00 -05:00
add_action ( 'customize_controls_init' , array ( $this , 'prepare_controls' ) );
2012-03-21 18:55:43 -04:00
add_action ( 'customize_controls_enqueue_scripts' , array ( $this , 'enqueue_control_scripts' ) );
2015-09-17 15:42:26 -04:00
Customize: Add global notifications area.
* Displays an error notification in the global area when a save attempt is rejected due to invalid settings. An error notification is also displayed when saving fails due to a network error or server error.
* Introduces `wp.customize.Notifications` subclass of `wp.customize.Values` to contain instances of `wp.customize.Notification` and manage their rendering into a container.
* Exposes the global notification area as `wp.customize.notifications` collection instance.
* Updates the `notifications` object on `Control` to use `Notifications` rather than `Values` and to re-use the rendering logic from the former. The old `Control#renderNotifications` method is deprecated.
* Allows notifications to be dismissed by instantiating them with a `dismissible` property.
* Allows `wp.customize.Notification` to be extended with custom templates and `render` functions.
* Triggers a `removed` event on `wp.customize.Values` instances _after_ a value has been removed from the collection.
Props delawski, westonruter, karmatosed, celloexpressions, Fab1en, melchoyce, Kelderic, afercia, adamsilverstein.
See #34893, #39896.
Fixes #35210, #31582, #37727, #37269.
Built from https://develop.svn.wordpress.org/trunk@41374
git-svn-id: http://core.svn.wordpress.org/trunk@41207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-12 03:03:46 -04:00
// Render Common, Panel, Section, and Control templates.
2015-09-17 15:42:26 -04:00
add_action ( 'customize_controls_print_footer_scripts' , array ( $this , 'render_panel_templates' ), 1 );
add_action ( 'customize_controls_print_footer_scripts' , array ( $this , 'render_section_templates' ), 1 );
add_action ( 'customize_controls_print_footer_scripts' , array ( $this , 'render_control_templates' ), 1 );
2016-10-27 17:51:31 -04:00
// Export header video settings with the partial response.
add_filter ( 'customize_render_partials_response' , array ( $this , 'export_header_video_settings' ), 10 , 3 );
2015-09-17 15:42:26 -04:00
// Export the settings to JS via the _wpCustomizeSettings variable.
add_action ( 'customize_controls_print_footer_scripts' , array ( $this , 'customize_pane_settings' ), 1000 );
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
// Add theme update notices.
if ( current_user_can ( 'install_themes' ) || current_user_can ( 'update_themes' ) ) {
2019-04-13 00:46:52 -04:00
require_once ABSPATH . 'wp-admin/includes/update.php' ;
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
add_action ( 'customize_controls_print_footer_scripts' , 'wp_print_admin_notice_templates' );
}
2012-02-24 23:12:43 -05:00
}
2012-07-26 17:45:33 -04:00
/**
2022-04-02 12:21:05 -04:00
* Returns true if it ' s an Ajax request .
2012-06-08 15:22:11 -04:00
*
* @ since 3.4 . 0
2015-04-05 11:00:27 -04:00
* @ since 4.2 . 0 Added `$action` param .
2012-07-26 17:45:33 -04:00
*
2016-07-09 20:51:30 -04:00
* @ param string | null $action Whether the supplied Ajax action is being run .
* @ return bool True if it ' s an Ajax request , false otherwise .
2012-06-08 15:22:11 -04:00
*/
2015-02-08 18:11:25 -05:00
public function doing_ajax ( $action = null ) {
2016-08-23 10:33:30 -04:00
if ( ! wp_doing_ajax () ) {
2015-02-08 18:11:25 -05:00
return false ;
}
if ( ! $action ) {
return true ;
} else {
2015-04-05 11:00:27 -04:00
/*
* Note : we can ' t just use doing_action ( " wp_ajax_ { $action } " ) because we need
* to check before admin - ajax . php gets to that point .
*/
2015-02-08 18:11:25 -05:00
return isset ( $_REQUEST [ 'action' ] ) && wp_unslash ( $_REQUEST [ 'action' ] ) === $action ;
}
2012-06-08 15:22:11 -04:00
}
/**
* Custom wp_die wrapper . Returns either the standard message for UI
2016-07-09 20:51:30 -04:00
* or the Ajax message .
2012-06-08 15:22:11 -04:00
*
* @ since 3.4 . 0
2012-07-26 17:45:33 -04:00
*
2019-11-05 16:27:02 -05:00
* @ param string | WP_Error $ajax_message Ajax return .
* @ param string $message Optional . UI message .
2012-06-08 15:22:11 -04:00
*/
2012-06-12 14:39:16 -04:00
protected function wp_die ( $ajax_message , $message = null ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( $this -> doing_ajax () ) {
2012-06-08 15:22:11 -04:00
wp_die ( $ajax_message );
2015-02-11 17:13:25 -05:00
}
2012-06-08 15:22:11 -04:00
2015-02-11 17:13:25 -05:00
if ( ! $message ) {
2018-02-18 21:13:32 -05:00
$message = __ ( 'Something went wrong.' );
2015-02-11 17:13:25 -05:00
}
2012-06-12 14:39:16 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( $this -> messenger_channel ) {
ob_start ();
wp_enqueue_scripts ();
wp_print_scripts ( array ( 'customize-base' ) );
$settings = array (
'messengerArgs' => array (
'channel' => $this -> messenger_channel ,
2017-11-30 18:11:00 -05:00
'url' => wp_customize_url (),
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
),
2017-11-30 18:11:00 -05:00
'error' => $ajax_message ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
);
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
$message .= ob_get_clean ();
ob_start ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
?>
< script >
( function ( api , settings ) {
var preview = new api . Messenger ( settings . messengerArgs );
preview . send ( 'iframe-loading-error' , settings . error );
2017-11-30 18:11:00 -05:00
} )( wp . customize , < ? php echo wp_json_encode ( $settings ); ?> );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
</ script >
< ? php
2023-09-29 15:47:21 -04:00
$message .= wp_get_inline_script_tag ( wp_remove_surrounding_empty_script_tags ( ob_get_clean () ) );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
2012-06-08 15:22:11 -04:00
wp_die ( $message );
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Returns the Ajax wp_die () handler if it ' s a customized request .
2012-04-17 17:43:47 -04:00
*
2012-06-08 15:22:11 -04:00
* @ since 3.4 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ deprecated 4.7 . 0
2012-07-26 17:45:33 -04:00
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ return callable Die handler .
2012-06-08 15:22:11 -04:00
*/
public function wp_die_handler () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
_deprecated_function ( __METHOD__ , '4.7.0' );
2015-02-11 17:13:25 -05:00
if ( $this -> doing_ajax () || isset ( $_POST [ 'customized' ] ) ) {
2012-06-08 15:22:11 -04:00
return '_ajax_wp_die_handler' ;
2015-02-11 17:13:25 -05:00
}
2012-06-08 15:22:11 -04:00
return '_default_wp_die_handler' ;
}
2012-11-17 10:11:29 -05:00
2012-06-08 15:22:11 -04:00
/**
2022-04-02 12:21:05 -04:00
* Starts preview and customize theme .
2012-07-26 17:45:33 -04:00
*
2022-01-20 18:53:05 -05:00
* Check if customize query variable exist . Init filters to filter the active theme .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
2017-03-29 07:41:46 -04:00
*
2022-04-04 14:26:06 -04:00
* @ global string $pagenow The filename of the current screen .
2012-02-24 23:12:43 -05:00
*/
2012-04-25 11:44:06 -04:00
public function setup_theme () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
global $pagenow ;
2012-06-12 14:39:16 -04:00
2020-01-28 19:45:18 -05:00
// Check permissions for customize.php access since this method is called before customize.php can run any code.
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( 'customize.php' === $pagenow && ! current_user_can ( 'customize' ) ) {
if ( ! is_user_logged_in () ) {
auth_redirect ();
} else {
wp_die (
2018-02-18 21:13:32 -05:00
'<h1>' . __ ( 'You need a higher level of permission.' ) . '</h1>' .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'<p>' . __ ( 'Sorry, you are not allowed to customize this site.' ) . '</p>' ,
403
);
}
return ;
2015-02-11 17:13:25 -05:00
}
2012-06-07 11:25:45 -04:00
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
// If a changeset was provided is invalid.
if ( isset ( $this -> _changeset_uuid ) && false !== $this -> _changeset_uuid && ! wp_is_uuid ( $this -> _changeset_uuid ) ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> wp_die ( - 1 , __ ( 'Invalid changeset UUID' ) );
}
2012-06-12 14:39:16 -04:00
2017-05-16 08:07:43 -04:00
/*
* Clear incoming post data if the user lacks a CSRF token ( nonce ) . Note that the customizer
* application will inject the customize_preview_nonce query parameter into all Ajax requests .
* For similar behavior elsewhere in WordPress , see rest_cookie_check_errors () which logs out
* a user when a valid nonce isn ' t present .
*/
$has_post_data_nonce = (
check_ajax_referer ( 'preview-customize_' . $this -> get_stylesheet (), 'nonce' , false )
||
check_ajax_referer ( 'save-customize_' . $this -> get_stylesheet (), 'nonce' , false )
||
check_ajax_referer ( 'preview-customize_' . $this -> get_stylesheet (), 'customize_preview_nonce' , false )
);
if ( ! current_user_can ( 'customize' ) || ! $has_post_data_nonce ) {
unset ( $_POST [ 'customized' ] );
unset ( $_REQUEST [ 'customized' ] );
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/*
* If unauthenticated then require a valid changeset UUID to load the preview .
* In this way , the UUID serves as a secret key . If the messenger channel is present ,
* then send unauthenticated code to prompt re - auth .
*/
if ( ! current_user_can ( 'customize' ) && ! $this -> changeset_post_id () ) {
$this -> wp_die ( $this -> messenger_channel ? 0 : - 1 , __ ( 'Non-existent changeset UUID.' ) );
2014-07-14 15:01:16 -04:00
}
2012-05-08 16:13:34 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! headers_sent () ) {
send_origin_headers ();
}
2012-06-06 16:34:24 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Hide the admin bar if we're embedded in the customizer iframe.
if ( $this -> messenger_channel ) {
show_admin_bar ( false );
}
2012-06-06 16:34:24 -04:00
2012-06-12 14:39:16 -04:00
if ( $this -> is_theme_active () ) {
// Once the theme is loaded, we'll validate it.
add_action ( 'after_setup_theme' , array ( $this , 'after_setup_theme' ) );
} else {
2023-07-09 16:17:29 -04:00
/*
* If the requested theme is not the active theme and the user doesn ' t have
* the switch_themes cap , bail .
*/
2015-02-11 17:13:25 -05:00
if ( ! current_user_can ( 'switch_themes' ) ) {
2016-06-29 11:16:29 -04:00
$this -> wp_die ( - 1 , __ ( 'Sorry, you are not allowed to edit theme options on this site.' ) );
2015-02-11 17:13:25 -05:00
}
2012-06-06 16:34:24 -04:00
2014-03-04 15:21:14 -05:00
// If the theme has errors while loading, bail.
2015-02-11 17:13:25 -05:00
if ( $this -> theme () -> errors () ) {
2015-09-03 05:21:23 -04:00
$this -> wp_die ( - 1 , $this -> theme () -> errors () -> get_error_message () );
2015-02-11 17:13:25 -05:00
}
2012-06-06 16:34:24 -04:00
2014-03-04 15:21:14 -05:00
// If the theme isn't allowed per multisite settings, bail.
2015-02-11 17:13:25 -05:00
if ( ! $this -> theme () -> is_allowed () ) {
2015-09-03 14:37:23 -04:00
$this -> wp_die ( - 1 , __ ( 'The requested theme does not exist.' ) );
2015-02-11 17:13:25 -05:00
}
2012-06-12 14:39:16 -04:00
}
2012-06-06 16:34:24 -04:00
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
// Make sure changeset UUID is established immediately after the theme is loaded.
add_action ( 'after_setup_theme' , array ( $this , 'establish_loaded_changeset' ), 5 );
2016-11-15 04:03:32 -05:00
/*
2017-08-22 07:52:48 -04:00
* Import theme starter content for fresh installations when landing in the customizer .
2016-11-15 04:03:32 -05:00
* Import starter content at after_setup_theme : 100 so that any
* add_theme_support ( 'starter-content' ) calls will have been made .
*/
if ( get_option ( 'fresh_site' ) && 'customize.php' === $pagenow ) {
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
add_action ( 'after_setup_theme' , array ( $this , 'import_theme_starter_content' ), 100 );
}
2012-04-25 11:44:06 -04:00
$this -> start_previewing_theme ();
2012-06-12 14:39:16 -04:00
}
2012-11-17 10:11:29 -05:00
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
/**
2022-04-02 12:21:05 -04:00
* Establishes the loaded changeset .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*
* This method runs right at after_setup_theme and applies the 'customize_changeset_branching' filter to determine
* whether concurrent changesets are allowed . Then if the Customizer is not initialized with a `changeset_uuid` param ,
* this method will determine which UUID should be used . If changeset branching is disabled , then the most saved
* changeset will be loaded by default . Otherwise , if there are no existing saved changesets or if changeset branching is
* enabled , then a new UUID will be generated .
*
* @ since 4.9 . 0
2020-06-16 17:07:14 -04:00
*
2022-04-04 14:26:06 -04:00
* @ global string $pagenow The filename of the current screen .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*/
public function establish_loaded_changeset () {
2018-01-22 01:49:31 -05:00
global $pagenow ;
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( empty ( $this -> _changeset_uuid ) ) {
$changeset_uuid = null ;
2017-10-07 02:00:54 -04:00
if ( ! $this -> branching () && $this -> is_theme_active () ) {
2017-11-30 18:11:00 -05:00
$unpublished_changeset_posts = $this -> get_changeset_posts (
array (
'post_status' => array_diff ( get_post_stati (), array ( 'auto-draft' , 'publish' , 'trash' , 'inherit' , 'private' ) ),
'exclude_restore_dismissed' => false ,
'author' => 'any' ,
'posts_per_page' => 1 ,
'order' => 'DESC' ,
'orderby' => 'date' ,
)
);
$unpublished_changeset_post = array_shift ( $unpublished_changeset_posts );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( ! empty ( $unpublished_changeset_post ) && wp_is_uuid ( $unpublished_changeset_post -> post_name ) ) {
$changeset_uuid = $unpublished_changeset_post -> post_name ;
}
}
// If no changeset UUID has been set yet, then generate a new one.
if ( empty ( $changeset_uuid ) ) {
$changeset_uuid = wp_generate_uuid4 ();
}
$this -> _changeset_uuid = $changeset_uuid ;
}
2017-10-12 00:01:46 -04:00
2018-01-22 01:49:31 -05:00
if ( is_admin () && 'customize.php' === $pagenow ) {
$this -> set_changeset_lock ( $this -> changeset_post_id () );
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
2012-07-26 17:45:33 -04:00
/**
* Callback to validate a theme once it is loaded
*
* @ since 3.4 . 0
*/
2014-05-19 01:45:16 -04:00
public function after_setup_theme () {
2016-05-23 01:10:27 -04:00
$doing_ajax_or_is_customized = ( $this -> doing_ajax () || isset ( $_POST [ 'customized' ] ) );
2015-02-11 17:13:25 -05:00
if ( ! $doing_ajax_or_is_customized && ! validate_current_theme () ) {
2012-06-12 14:39:16 -04:00
wp_redirect ( 'themes.php?broken=true' );
exit ;
}
2012-04-25 11:44:06 -04:00
}
2012-02-24 23:12:43 -05:00
2012-04-25 11:44:06 -04:00
/**
2014-08-08 19:31:15 -04:00
* If the theme to be previewed isn ' t the active theme , add filter callbacks
* to swap it out at runtime .
2012-04-25 11:44:06 -04:00
*
* @ since 3.4 . 0
*/
public function start_previewing_theme () {
2012-06-06 16:34:24 -04:00
// Bail if we're already previewing.
2015-02-11 17:13:25 -05:00
if ( $this -> is_preview () ) {
2012-04-25 11:44:06 -04:00
return ;
2015-02-11 17:13:25 -05:00
}
2012-02-24 23:12:43 -05:00
2012-04-25 11:44:06 -04:00
$this -> previewing = true ;
2012-06-12 14:39:16 -04:00
if ( ! $this -> is_theme_active () ) {
add_filter ( 'template' , array ( $this , 'get_template' ) );
add_filter ( 'stylesheet' , array ( $this , 'get_stylesheet' ) );
add_filter ( 'pre_option_current_theme' , array ( $this , 'current_theme' ) );
2012-06-12 15:27:41 -04:00
2014-09-29 09:28:16 -04:00
// @link: https://core.trac.wordpress.org/ticket/20027
2012-06-12 14:39:16 -04:00
add_filter ( 'pre_option_stylesheet' , array ( $this , 'get_stylesheet' ) );
add_filter ( 'pre_option_template' , array ( $this , 'get_template' ) );
2012-06-12 15:27:41 -04:00
2012-06-12 14:39:16 -04:00
// Handle custom theme roots.
add_filter ( 'pre_option_stylesheet_root' , array ( $this , 'get_stylesheet_root' ) );
add_filter ( 'pre_option_template_root' , array ( $this , 'get_template_root' ) );
}
2012-04-17 17:43:47 -04:00
2014-03-06 09:11:15 -05:00
/**
* Fires once the Customizer theme preview has started .
*
* @ since 3.4 . 0
*
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2014-03-06 09:11:15 -05:00
*/
2012-04-30 13:20:32 -04:00
do_action ( 'start_previewing_theme' , $this );
2012-04-25 11:44:06 -04:00
}
/**
2022-04-02 12:21:05 -04:00
* Stops previewing the selected theme .
2012-04-25 11:44:06 -04:00
*
2022-01-20 18:53:05 -05:00
* Removes filters to change the active theme .
2012-04-25 11:44:06 -04:00
*
* @ since 3.4 . 0
*/
public function stop_previewing_theme () {
2015-02-11 17:13:25 -05:00
if ( ! $this -> is_preview () ) {
2012-04-25 11:44:06 -04:00
return ;
2015-02-11 17:13:25 -05:00
}
2012-04-25 11:44:06 -04:00
$this -> previewing = false ;
2012-06-12 14:39:16 -04:00
if ( ! $this -> is_theme_active () ) {
remove_filter ( 'template' , array ( $this , 'get_template' ) );
remove_filter ( 'stylesheet' , array ( $this , 'get_stylesheet' ) );
remove_filter ( 'pre_option_current_theme' , array ( $this , 'current_theme' ) );
2012-06-12 15:27:41 -04:00
2014-09-29 09:28:16 -04:00
// @link: https://core.trac.wordpress.org/ticket/20027
2012-06-12 14:39:16 -04:00
remove_filter ( 'pre_option_stylesheet' , array ( $this , 'get_stylesheet' ) );
remove_filter ( 'pre_option_template' , array ( $this , 'get_template' ) );
2012-06-12 15:27:41 -04:00
2012-06-12 14:39:16 -04:00
// Handle custom theme roots.
remove_filter ( 'pre_option_stylesheet_root' , array ( $this , 'get_stylesheet_root' ) );
remove_filter ( 'pre_option_template_root' , array ( $this , 'get_template_root' ) );
}
2012-04-25 11:44:06 -04:00
2014-03-06 09:11:15 -05:00
/**
* Fires once the Customizer theme preview has stopped .
*
* @ since 3.4 . 0
*
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2014-03-06 09:11:15 -05:00
*/
2012-04-30 13:20:32 -04:00
do_action ( 'stop_previewing_theme' , $this );
2012-02-24 23:12:43 -05:00
}
2017-08-02 01:35:41 -04:00
/**
* Gets whether settings are or will be previewed .
*
* @ since 4.9 . 0
2020-06-16 17:07:14 -04:00
*
2017-08-02 01:35:41 -04:00
* @ see WP_Customize_Setting :: preview ()
*
* @ return bool
*/
public function settings_previewed () {
return $this -> settings_previewed ;
}
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
/**
* Gets whether data from a changeset ' s autosaved revision should be loaded if it exists .
*
* @ since 4.9 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
* @ see WP_Customize_Manager :: changeset_data ()
*
* @ return bool Is using autosaved changeset revision .
*/
public function autosaved () {
return $this -> autosaved ;
}
/**
* Whether the changeset branching is allowed .
*
* @ since 4.9 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
* @ see WP_Customize_Manager :: establish_loaded_changeset ()
*
* @ return bool Is changeset branching .
*/
public function branching () {
/**
* Filters whether or not changeset branching is allowed .
*
* By default in core , when changeset branching is not allowed , changesets will operate
* linearly in that only one saved changeset will exist at a time ( with a 'draft' or
* 'future' status ) . This makes the Customizer operate in a way that is similar to going to
* " edit " to one existing post : all users will be making changes to the same post , and autosave
* revisions will be made for that post .
*
* By contrast , when changeset branching is allowed , then the model is like users going
* to " add new " for a page and each user makes changes independently of each other since
* they are all operating on their own separate pages , each getting their own separate
* initial auto - drafts and then once initially saved , autosave revisions on top of that
* user ' s specific post .
*
* Since linear changesets are deemed to be more suitable for the majority of WordPress users ,
* they are the default . For WordPress sites that have heavy site management in the Customizer
* by multiple users then branching changesets should be enabled by means of this filter .
*
* @ since 4.9 . 0
*
* @ param bool $allow_branching Whether branching is allowed . If `false` , the default ,
* then only one saved changeset exists at a time .
* @ param WP_Customize_Manager $wp_customize Manager instance .
*/
$this -> branching = apply_filters ( 'customize_changeset_branching' , $this -> branching , $this );
return $this -> branching ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets the changeset UUID .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
* @ see WP_Customize_Manager :: establish_loaded_changeset ()
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ return string UUID .
*/
public function changeset_uuid () {
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( empty ( $this -> _changeset_uuid ) ) {
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
$this -> establish_loaded_changeset ();
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return $this -> _changeset_uuid ;
}
2012-05-23 13:56:42 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets the theme being customized .
2012-05-23 13:56:42 -04:00
*
* @ since 3.4 . 0
*
* @ return WP_Theme
*/
2012-05-23 17:21:29 -04:00
public function theme () {
2015-02-24 22:54:25 -05:00
if ( ! $this -> theme ) {
$this -> theme = wp_get_theme ();
}
2012-05-23 17:21:29 -04:00
return $this -> theme ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets the registered settings .
2012-05-23 17:21:29 -04:00
*
* @ since 3.4 . 0
*
* @ return array
*/
public function settings () {
return $this -> settings ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets the registered controls .
2012-05-23 17:21:29 -04:00
*
* @ since 3.4 . 0
*
* @ return array
*/
public function controls () {
return $this -> controls ;
}
2014-08-14 00:43:16 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets the registered containers .
2014-08-14 00:43:16 -04:00
*
* @ since 4.0 . 0
*
* @ return array
*/
public function containers () {
return $this -> containers ;
}
2012-05-23 17:21:29 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets the registered sections .
2012-05-23 17:21:29 -04:00
*
* @ since 3.4 . 0
*
* @ return array
*/
public function sections () {
return $this -> sections ;
2012-05-23 13:56:42 -04:00
}
2014-06-26 16:17:15 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets the registered panels .
2014-06-26 16:17:15 -04:00
*
* @ since 4.0 . 0
*
2014-07-13 20:36:15 -04:00
* @ return array Panels .
2014-06-26 16:17:15 -04:00
*/
public function panels () {
return $this -> panels ;
}
2012-05-16 01:55:54 -04:00
/**
* Checks if the current theme is active .
*
* @ since 3.4 . 0
2012-05-23 13:56:42 -04:00
*
* @ return bool
2012-05-16 01:55:54 -04:00
*/
2012-05-23 13:56:42 -04:00
public function is_theme_active () {
2020-05-19 04:41:12 -04:00
return $this -> get_stylesheet () === $this -> original_stylesheet ;
2012-05-16 01:55:54 -04:00
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Registers styles / scripts and initialize the preview of each setting
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*/
2012-02-29 19:14:51 -05:00
public function wp_loaded () {
2014-03-06 09:11:15 -05:00
2023-07-09 16:17:29 -04:00
/*
* Unconditionally register core types for panels , sections , and controls
* in case plugin unhooks all customize_register actions .
*/
2017-10-25 17:45:49 -04:00
$this -> register_panel_type ( 'WP_Customize_Panel' );
$this -> register_panel_type ( 'WP_Customize_Themes_Panel' );
$this -> register_section_type ( 'WP_Customize_Section' );
$this -> register_section_type ( 'WP_Customize_Sidebar_Section' );
$this -> register_section_type ( 'WP_Customize_Themes_Section' );
$this -> register_control_type ( 'WP_Customize_Color_Control' );
$this -> register_control_type ( 'WP_Customize_Media_Control' );
$this -> register_control_type ( 'WP_Customize_Upload_Control' );
$this -> register_control_type ( 'WP_Customize_Image_Control' );
$this -> register_control_type ( 'WP_Customize_Background_Image_Control' );
$this -> register_control_type ( 'WP_Customize_Background_Position_Control' );
$this -> register_control_type ( 'WP_Customize_Cropped_Image_Control' );
$this -> register_control_type ( 'WP_Customize_Site_Icon_Control' );
$this -> register_control_type ( 'WP_Customize_Theme_Control' );
$this -> register_control_type ( 'WP_Customize_Code_Editor_Control' );
$this -> register_control_type ( 'WP_Customize_Date_Time_Control' );
2014-03-06 09:11:15 -05:00
/**
* Fires once WordPress has loaded , allowing scripts and styles to be initialized .
*
* @ since 3.4 . 0
*
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2014-03-06 09:11:15 -05:00
*/
2012-04-30 13:20:32 -04:00
do_action ( 'customize_register' , $this );
2012-02-24 23:12:43 -05:00
2017-08-02 01:35:41 -04:00
if ( $this -> settings_previewed () ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
foreach ( $this -> settings as $setting ) {
$setting -> preview ();
}
}
if ( $this -> is_preview () && ! is_admin () ) {
2012-03-28 11:04:11 -04:00
$this -> customize_preview_init ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
2012-03-21 18:55:43 -04:00
}
2012-05-23 21:48:32 -04:00
/**
2016-07-09 20:51:30 -04:00
* Prevents Ajax requests from following redirects when previewing a theme
2012-05-23 21:48:32 -04:00
* by issuing a 200 response instead of a 30 x .
*
* Instead , the JS will sniff out the location header .
*
* @ since 3.4 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ deprecated 4.7 . 0
2012-07-26 17:45:33 -04:00
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ param int $status Status .
2012-07-26 17:45:33 -04:00
* @ return int
2012-05-23 21:48:32 -04:00
*/
public function wp_redirect_status ( $status ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
_deprecated_function ( __FUNCTION__ , '4.7.0' );
if ( $this -> is_preview () && ! is_admin () ) {
2012-05-23 21:48:32 -04:00
return 200 ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
2012-05-23 21:48:32 -04:00
return $status ;
}
2012-04-30 11:46:17 -04:00
/**
2022-04-02 12:21:05 -04:00
* Finds the changeset post ID for a given changeset UUID .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ param string $uuid Changeset UUID .
* @ return int | null Returns post ID on success and null on failure .
*/
public function find_changeset_post_id ( $uuid ) {
2017-11-30 18:11:00 -05:00
$cache_group = 'customize_changeset_post' ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$changeset_post_id = wp_cache_get ( $uuid , $cache_group );
if ( $changeset_post_id && 'customize_changeset' === get_post_type ( $changeset_post_id ) ) {
return $changeset_post_id ;
}
2017-11-30 18:11:00 -05:00
$changeset_post_query = new WP_Query (
array (
'post_type' => 'customize_changeset' ,
'post_status' => get_post_stati (),
'name' => $uuid ,
'posts_per_page' => 1 ,
'no_found_rows' => true ,
'cache_results' => true ,
'update_post_meta_cache' => false ,
'update_post_term_cache' => false ,
'lazy_load_term_meta' => false ,
)
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! empty ( $changeset_post_query -> posts ) ) {
// Note: 'fields'=>'ids' is not being used in order to cache the post object as it will be needed.
$changeset_post_id = $changeset_post_query -> posts [ 0 ] -> ID ;
2017-08-29 00:10:46 -04:00
wp_cache_set ( $uuid , $changeset_post_id , $cache_group );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return $changeset_post_id ;
}
return null ;
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets changeset posts .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*
* @ since 4.9 . 0
*
* @ param array $args {
* Args to pass into `get_posts()` to query changesets .
*
* @ type int $posts_per_page Number of posts to return . Defaults to - 1 ( all posts ) .
* @ type int $author Post author . Defaults to current user .
* @ type string $post_status Status of changeset . Defaults to 'auto-draft' .
* @ type bool $exclude_restore_dismissed Whether to exclude changeset auto - drafts that have been dismissed . Defaults to true .
* }
* @ return WP_Post [] Auto - draft changesets .
*/
protected function get_changeset_posts ( $args = array () ) {
$default_args = array (
'exclude_restore_dismissed' => true ,
2017-11-30 18:11:00 -05:00
'posts_per_page' => - 1 ,
'post_type' => 'customize_changeset' ,
'post_status' => 'auto-draft' ,
'order' => 'DESC' ,
'orderby' => 'date' ,
'no_found_rows' => true ,
'cache_results' => true ,
'update_post_meta_cache' => false ,
'update_post_term_cache' => false ,
'lazy_load_term_meta' => false ,
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
);
if ( get_current_user_id () ) {
$default_args [ 'author' ] = get_current_user_id ();
}
$args = array_merge ( $default_args , $args );
if ( ! empty ( $args [ 'exclude_restore_dismissed' ] ) ) {
unset ( $args [ 'exclude_restore_dismissed' ] );
$args [ 'meta_query' ] = array (
array (
2017-11-30 18:11:00 -05:00
'key' => '_customize_restore_dismissed' ,
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
'compare' => 'NOT EXISTS' ,
),
);
}
return get_posts ( $args );
}
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
/**
2022-04-02 12:21:05 -04:00
* Dismisses all of the current user ' s auto - drafts ( other than the present one ) .
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
*
* @ since 4.9 . 0
* @ return int The number of auto - drafts that were dismissed .
*/
protected function dismiss_user_auto_draft_changesets () {
2017-11-30 18:11:00 -05:00
$changeset_autodraft_posts = $this -> get_changeset_posts (
array (
'post_status' => 'auto-draft' ,
'exclude_restore_dismissed' => true ,
'posts_per_page' => - 1 ,
)
);
$dismissed = 0 ;
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
foreach ( $changeset_autodraft_posts as $autosave_autodraft_post ) {
if ( $autosave_autodraft_post -> ID === $this -> changeset_post_id () ) {
continue ;
}
if ( update_post_meta ( $autosave_autodraft_post -> ID , '_customize_restore_dismissed' , true ) ) {
2023-09-09 05:28:26 -04:00
++ $dismissed ;
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
}
}
return $dismissed ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets the changeset post ID for the loaded changeset .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ return int | null Post ID on success or null if there is no post yet saved .
*/
public function changeset_post_id () {
if ( ! isset ( $this -> _changeset_post_id ) ) {
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
$post_id = $this -> find_changeset_post_id ( $this -> changeset_uuid () );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! $post_id ) {
$post_id = false ;
}
$this -> _changeset_post_id = $post_id ;
}
if ( false === $this -> _changeset_post_id ) {
return null ;
}
return $this -> _changeset_post_id ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets the data stored in a changeset post .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ param int $post_id Changeset post ID .
* @ return array | WP_Error Changeset data or WP_Error on error .
*/
protected function get_changeset_post_data ( $post_id ) {
if ( ! $post_id ) {
return new WP_Error ( 'empty_post_id' );
}
$changeset_post = get_post ( $post_id );
if ( ! $changeset_post ) {
return new WP_Error ( 'missing_post' );
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( 'revision' === $changeset_post -> post_type ) {
if ( 'customize_changeset' !== get_post_type ( $changeset_post -> post_parent ) ) {
return new WP_Error ( 'wrong_post_type' );
}
} elseif ( 'customize_changeset' !== $changeset_post -> post_type ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return new WP_Error ( 'wrong_post_type' );
}
$changeset_data = json_decode ( $changeset_post -> post_content , true );
2019-09-20 16:08:57 -04:00
$last_error = json_last_error ();
if ( $last_error ) {
return new WP_Error ( 'json_parse_error' , '' , $last_error );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
if ( ! is_array ( $changeset_data ) ) {
return new WP_Error ( 'expected_array' );
}
return $changeset_data ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets changeset data .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
* @ since 4.9 . 0 This will return the changeset 's data with a user' s autosave revision merged on top , if one exists and $autosaved is true .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ return array Changeset data .
*/
public function changeset_data () {
if ( isset ( $this -> _changeset_data ) ) {
return $this -> _changeset_data ;
}
$changeset_post_id = $this -> changeset_post_id ();
if ( ! $changeset_post_id ) {
$this -> _changeset_data = array ();
} else {
2018-01-29 19:21:30 -05:00
if ( $this -> autosaved () && is_user_logged_in () ) {
2017-10-12 00:01:46 -04:00
$autosave_post = wp_get_post_autosave ( $changeset_post_id , get_current_user_id () );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( $autosave_post ) {
$data = $this -> get_changeset_post_data ( $autosave_post -> ID );
if ( ! is_wp_error ( $data ) ) {
$this -> _changeset_data = $data ;
}
}
}
// Load data from the changeset if it was not loaded from an autosave.
if ( ! isset ( $this -> _changeset_data ) ) {
$data = $this -> get_changeset_post_data ( $changeset_post_id );
if ( ! is_wp_error ( $data ) ) {
$this -> _changeset_data = $data ;
} else {
$this -> _changeset_data = array ();
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
}
return $this -> _changeset_data ;
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
/**
2016-11-15 04:03:32 -05:00
* Starter content setting IDs .
*
* @ since 4.7 . 0
* @ var array
*/
2016-11-17 03:18:32 -05:00
protected $pending_starter_content_settings_ids = array ();
2016-11-15 04:03:32 -05:00
/**
2022-04-02 12:21:05 -04:00
* Imports theme starter content into the customized state .
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
*
* @ since 4.7 . 0
*
* @ param array $starter_content Starter content . Defaults to `get_theme_starter_content()` .
*/
2021-10-18 13:52:58 -04:00
public function import_theme_starter_content ( $starter_content = array () ) {
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
if ( empty ( $starter_content ) ) {
$starter_content = get_theme_starter_content ();
}
2016-11-15 04:03:32 -05:00
$changeset_data = array ();
if ( $this -> changeset_post_id () ) {
2017-11-02 15:00:54 -04:00
/*
* Don ' t re - import starter content into a changeset saved persistently .
* This will need to be revisited in the future once theme switching
* is allowed with drafted / scheduled changesets , since switching to
* another theme could result in more starter content being applied .
* However , when doing an explicit save it is currently possible for
* nav menus and nav menu items specifically to lose their starter_content
* flags , thus resulting in duplicates being created since they fail
* to get re - used . See #40146.
*/
if ( 'auto-draft' !== get_post_status ( $this -> changeset_post_id () ) ) {
return ;
}
2016-11-15 04:03:32 -05:00
$changeset_data = $this -> get_changeset_post_data ( $this -> changeset_post_id () );
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
$sidebars_widgets = isset ( $starter_content [ 'widgets' ] ) && ! empty ( $this -> widgets ) ? $starter_content [ 'widgets' ] : array ();
2017-11-30 18:11:00 -05:00
$attachments = isset ( $starter_content [ 'attachments' ] ) && ! empty ( $this -> nav_menus ) ? $starter_content [ 'attachments' ] : array ();
$posts = isset ( $starter_content [ 'posts' ] ) && ! empty ( $this -> nav_menus ) ? $starter_content [ 'posts' ] : array ();
$options = isset ( $starter_content [ 'options' ] ) ? $starter_content [ 'options' ] : array ();
$nav_menus = isset ( $starter_content [ 'nav_menus' ] ) && ! empty ( $this -> nav_menus ) ? $starter_content [ 'nav_menus' ] : array ();
$theme_mods = isset ( $starter_content [ 'theme_mods' ] ) ? $starter_content [ 'theme_mods' ] : array ();
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
// Widgets.
$max_widget_numbers = array ();
foreach ( $sidebars_widgets as $sidebar_id => $widgets ) {
$sidebar_widget_ids = array ();
foreach ( $widgets as $widget ) {
list ( $id_base , $instance ) = $widget ;
if ( ! isset ( $max_widget_numbers [ $id_base ] ) ) {
// When $settings is an array-like object, get an intrinsic array for use with array_keys().
$settings = get_option ( " widget_ { $id_base } " , array () );
if ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) {
$settings = $settings -> getArrayCopy ();
}
2020-09-30 11:46:08 -04:00
unset ( $settings [ '_multiwidget' ] );
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
// Find the max widget number for this type.
$widget_numbers = array_keys ( $settings );
2016-11-02 20:00:32 -04:00
if ( count ( $widget_numbers ) > 0 ) {
2017-11-30 18:11:00 -05:00
$widget_numbers [] = 1 ;
2019-09-15 07:27:55 -04:00
$max_widget_numbers [ $id_base ] = max ( ... $widget_numbers );
2016-11-02 20:00:32 -04:00
} else {
$max_widget_numbers [ $id_base ] = 1 ;
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
$max_widget_numbers [ $id_base ] += 1 ;
2017-11-30 18:11:00 -05:00
$widget_id = sprintf ( '%s-%d' , $id_base , $max_widget_numbers [ $id_base ] );
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
$setting_id = sprintf ( 'widget_%s[%d]' , $id_base , $max_widget_numbers [ $id_base ] );
2016-11-15 04:03:32 -05:00
$setting_value = $this -> widgets -> sanitize_widget_js_instance ( $instance );
if ( empty ( $changeset_data [ $setting_id ] ) || ! empty ( $changeset_data [ $setting_id ][ 'starter_content' ] ) ) {
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
$this -> set_post_value ( $setting_id , $setting_value );
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $setting_id ;
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
$sidebar_widget_ids [] = $widget_id ;
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
$setting_id = sprintf ( 'sidebars_widgets[%s]' , $sidebar_id );
if ( empty ( $changeset_data [ $setting_id ] ) || ! empty ( $changeset_data [ $setting_id ][ 'starter_content' ] ) ) {
$this -> set_post_value ( $setting_id , $sidebar_widget_ids );
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $setting_id ;
2016-11-15 04:03:32 -05:00
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-23 04:53:33 -05:00
$starter_content_auto_draft_post_ids = array ();
if ( ! empty ( $changeset_data [ 'nav_menus_created_posts' ][ 'value' ] ) ) {
$starter_content_auto_draft_post_ids = array_merge ( $starter_content_auto_draft_post_ids , $changeset_data [ 'nav_menus_created_posts' ][ 'value' ] );
}
2016-12-01 19:25:41 -05:00
// Make an index of all the posts needed and what their slugs are.
$needed_posts = array ();
2017-11-30 18:11:00 -05:00
$attachments = $this -> prepare_starter_content_attachments ( $attachments );
2016-12-01 19:25:41 -05:00
foreach ( $attachments as $attachment ) {
2017-11-30 18:11:00 -05:00
$key = 'attachment:' . $attachment [ 'post_name' ];
2016-12-01 19:25:41 -05:00
$needed_posts [ $key ] = true ;
}
foreach ( array_keys ( $posts ) as $post_symbol ) {
if ( empty ( $posts [ $post_symbol ][ 'post_name' ] ) && empty ( $posts [ $post_symbol ][ 'post_title' ] ) ) {
unset ( $posts [ $post_symbol ] );
continue ;
}
if ( empty ( $posts [ $post_symbol ][ 'post_name' ] ) ) {
$posts [ $post_symbol ][ 'post_name' ] = sanitize_title ( $posts [ $post_symbol ][ 'post_title' ] );
}
if ( empty ( $posts [ $post_symbol ][ 'post_type' ] ) ) {
$posts [ $post_symbol ][ 'post_type' ] = 'post' ;
}
$needed_posts [ $posts [ $post_symbol ][ 'post_type' ] . ':' . $posts [ $post_symbol ][ 'post_name' ] ] = true ;
}
$all_post_slugs = array_merge (
wp_list_pluck ( $attachments , 'post_name' ),
wp_list_pluck ( $posts , 'post_name' )
);
2017-01-18 19:01:46 -05:00
/*
* Obtain all post types referenced in starter content to use in query .
* This is needed because 'any' will not account for post types not yet registered .
*/
$post_types = array_filter ( array_merge ( array ( 'attachment' ), wp_list_pluck ( $posts , 'post_type' ) ) );
2016-12-01 19:25:41 -05:00
// Re-use auto-draft starter content posts referenced in the current customized state.
2016-11-23 04:53:33 -05:00
$existing_starter_content_posts = array ();
if ( ! empty ( $starter_content_auto_draft_post_ids ) ) {
2017-11-30 18:11:00 -05:00
$existing_posts_query = new WP_Query (
array (
'post__in' => $starter_content_auto_draft_post_ids ,
'post_status' => 'auto-draft' ,
'post_type' => $post_types ,
'posts_per_page' => - 1 ,
)
);
2016-11-23 04:53:33 -05:00
foreach ( $existing_posts_query -> posts as $existing_post ) {
2016-12-05 14:33:42 -05:00
$post_name = $existing_post -> post_name ;
if ( empty ( $post_name ) ) {
$post_name = get_post_meta ( $existing_post -> ID , '_customize_draft_post_name' , true );
}
$existing_starter_content_posts [ $existing_post -> post_type . ':' . $post_name ] = $existing_post ;
2016-11-15 04:03:32 -05:00
}
2016-11-23 04:53:33 -05:00
}
2016-12-01 19:25:41 -05:00
// Re-use non-auto-draft posts.
if ( ! empty ( $all_post_slugs ) ) {
2017-11-30 18:11:00 -05:00
$existing_posts_query = new WP_Query (
array (
'post_name__in' => $all_post_slugs ,
'post_status' => array_diff ( get_post_stati (), array ( 'auto-draft' ) ),
'post_type' => 'any' ,
'posts_per_page' => - 1 ,
)
);
2016-12-01 19:25:41 -05:00
foreach ( $existing_posts_query -> posts as $existing_post ) {
$key = $existing_post -> post_type . ':' . $existing_post -> post_name ;
if ( isset ( $needed_posts [ $key ] ) && ! isset ( $existing_starter_content_posts [ $key ] ) ) {
$existing_starter_content_posts [ $key ] = $existing_post ;
}
}
}
2016-11-23 04:53:33 -05:00
// Attachments are technically posts but handled differently.
if ( ! empty ( $attachments ) ) {
2016-11-15 04:03:32 -05:00
2016-11-23 04:53:33 -05:00
$attachment_ids = array ();
foreach ( $attachments as $symbol => $attachment ) {
2017-11-30 18:11:00 -05:00
$file_array = array (
2016-12-01 19:25:41 -05:00
'name' => $attachment [ 'file_name' ],
);
2017-11-30 18:11:00 -05:00
$file_path = $attachment [ 'file_path' ];
2016-11-23 04:53:33 -05:00
$attachment_id = null ;
$attached_file = null ;
if ( isset ( $existing_starter_content_posts [ 'attachment:' . $attachment [ 'post_name' ] ] ) ) {
$attachment_post = $existing_starter_content_posts [ 'attachment:' . $attachment [ 'post_name' ] ];
2017-11-30 18:11:00 -05:00
$attachment_id = $attachment_post -> ID ;
$attached_file = get_attached_file ( $attachment_id );
2016-11-23 04:53:33 -05:00
if ( empty ( $attached_file ) || ! file_exists ( $attached_file ) ) {
$attachment_id = null ;
$attached_file = null ;
} elseif ( $this -> get_stylesheet () !== get_post_meta ( $attachment_post -> ID , '_starter_content_theme' , true ) ) {
// Re-generate attachment metadata since it was previously generated for a different theme.
$metadata = wp_generate_attachment_metadata ( $attachment_post -> ID , $attached_file );
wp_update_attachment_metadata ( $attachment_id , $metadata );
update_post_meta ( $attachment_id , '_starter_content_theme' , $this -> get_stylesheet () );
}
2016-11-15 04:03:32 -05:00
}
2016-11-23 04:53:33 -05:00
// Insert the attachment auto-draft because it doesn't yet exist or the attached file is gone.
if ( ! $attachment_id ) {
// Copy file to temp location so that original file won't get deleted from theme after sideloading.
2019-03-01 15:58:52 -05:00
$temp_file_name = wp_tempnam ( wp_basename ( $file_path ) );
2016-11-23 04:53:33 -05:00
if ( $temp_file_name && copy ( $file_path , $temp_file_name ) ) {
$file_array [ 'tmp_name' ] = $temp_file_name ;
}
if ( empty ( $file_array [ 'tmp_name' ] ) ) {
continue ;
}
$attachment_post_data = array_merge (
2016-12-05 14:33:42 -05:00
wp_array_slice_assoc ( $attachment , array ( 'post_title' , 'post_content' , 'post_excerpt' ) ),
2016-11-23 04:53:33 -05:00
array (
'post_status' => 'auto-draft' , // So attachment will be garbage collected in a week if changeset is never published.
)
);
$attachment_id = media_handle_sideload ( $file_array , 0 , null , $attachment_post_data );
if ( is_wp_error ( $attachment_id ) ) {
continue ;
}
update_post_meta ( $attachment_id , '_starter_content_theme' , $this -> get_stylesheet () );
2016-12-05 14:33:42 -05:00
update_post_meta ( $attachment_id , '_customize_draft_post_name' , $attachment [ 'post_name' ] );
2016-11-23 04:53:33 -05:00
}
$attachment_ids [ $symbol ] = $attachment_id ;
2016-11-15 04:03:32 -05:00
}
2016-12-01 19:25:41 -05:00
$starter_content_auto_draft_post_ids = array_merge ( $starter_content_auto_draft_post_ids , array_values ( $attachment_ids ) );
2016-11-23 04:53:33 -05:00
}
2016-11-15 04:03:32 -05:00
2016-11-23 04:53:33 -05:00
// Posts & pages.
if ( ! empty ( $posts ) ) {
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
foreach ( array_keys ( $posts ) as $post_symbol ) {
2016-12-01 19:25:41 -05:00
if ( empty ( $posts [ $post_symbol ][ 'post_type' ] ) || empty ( $posts [ $post_symbol ][ 'post_name' ] ) ) {
2016-11-15 04:03:32 -05:00
continue ;
}
$post_type = $posts [ $post_symbol ][ 'post_type' ];
if ( ! empty ( $posts [ $post_symbol ][ 'post_name' ] ) ) {
$post_name = $posts [ $post_symbol ][ 'post_name' ];
} elseif ( ! empty ( $posts [ $post_symbol ][ 'post_title' ] ) ) {
$post_name = sanitize_title ( $posts [ $post_symbol ][ 'post_title' ] );
} else {
continue ;
}
// Use existing auto-draft post if one already exists with the same type and name.
2016-11-23 04:53:33 -05:00
if ( isset ( $existing_starter_content_posts [ $post_type . ':' . $post_name ] ) ) {
$posts [ $post_symbol ][ 'ID' ] = $existing_starter_content_posts [ $post_type . ':' . $post_name ] -> ID ;
2016-11-15 04:03:32 -05:00
continue ;
}
2016-11-23 04:53:33 -05:00
// Translate the featured image symbol.
if ( ! empty ( $posts [ $post_symbol ][ 'thumbnail' ] )
&& preg_match ( '/^{{(?P<symbol>.+)}}$/' , $posts [ $post_symbol ][ 'thumbnail' ], $matches )
&& isset ( $attachment_ids [ $matches [ 'symbol' ] ] ) ) {
$posts [ $post_symbol ][ 'meta_input' ][ '_thumbnail_id' ] = $attachment_ids [ $matches [ 'symbol' ] ];
}
if ( ! empty ( $posts [ $post_symbol ][ 'template' ] ) ) {
$posts [ $post_symbol ][ 'meta_input' ][ '_wp_page_template' ] = $posts [ $post_symbol ][ 'template' ];
}
2016-10-30 16:21:33 -04:00
$r = $this -> nav_menus -> insert_auto_draft_post ( $posts [ $post_symbol ] );
if ( $r instanceof WP_Post ) {
$posts [ $post_symbol ][ 'ID' ] = $r -> ID ;
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
2016-11-23 04:53:33 -05:00
$starter_content_auto_draft_post_ids = array_merge ( $starter_content_auto_draft_post_ids , wp_list_pluck ( $posts , 'ID' ) );
}
// The nav_menus_created_posts setting is why nav_menus component is dependency for adding posts.
if ( ! empty ( $this -> nav_menus ) && ! empty ( $starter_content_auto_draft_post_ids ) ) {
2016-11-15 04:03:32 -05:00
$setting_id = 'nav_menus_created_posts' ;
2016-11-23 04:53:33 -05:00
$this -> set_post_value ( $setting_id , array_unique ( array_values ( $starter_content_auto_draft_post_ids ) ) );
$this -> pending_starter_content_settings_ids [] = $setting_id ;
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
// Nav menus.
2017-11-30 18:11:00 -05:00
$placeholder_id = - 1 ;
2016-11-15 04:03:32 -05:00
$reused_nav_menu_setting_ids = array ();
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
foreach ( $nav_menus as $nav_menu_location => $nav_menu ) {
2016-11-15 04:03:32 -05:00
2017-11-30 18:11:00 -05:00
$nav_menu_term_id = null ;
2016-11-15 04:03:32 -05:00
$nav_menu_setting_id = null ;
2017-11-30 18:11:00 -05:00
$matches = array ();
2016-11-15 04:03:32 -05:00
// Look for an existing placeholder menu with starter content to re-use.
foreach ( $changeset_data as $setting_id => $setting_params ) {
$can_reuse = (
! empty ( $setting_params [ 'starter_content' ] )
&&
! in_array ( $setting_id , $reused_nav_menu_setting_ids , true )
&&
preg_match ( '#^nav_menu\[(?P<nav_menu_id>-?\d+)\]$#' , $setting_id , $matches )
);
if ( $can_reuse ) {
2020-10-08 17:15:13 -04:00
$nav_menu_term_id = ( int ) $matches [ 'nav_menu_id' ];
2017-11-30 18:11:00 -05:00
$nav_menu_setting_id = $setting_id ;
2016-11-15 04:03:32 -05:00
$reused_nav_menu_setting_ids [] = $setting_id ;
break ;
}
}
if ( ! $nav_menu_term_id ) {
while ( isset ( $changeset_data [ sprintf ( 'nav_menu[%d]' , $placeholder_id ) ] ) ) {
2023-09-09 05:28:26 -04:00
-- $placeholder_id ;
2016-11-15 04:03:32 -05:00
}
2017-11-30 18:11:00 -05:00
$nav_menu_term_id = $placeholder_id ;
2016-11-15 04:03:32 -05:00
$nav_menu_setting_id = sprintf ( 'nav_menu[%d]' , $placeholder_id );
}
2017-11-30 18:11:00 -05:00
$this -> set_post_value (
2018-08-16 21:51:36 -04:00
$nav_menu_setting_id ,
array (
2017-11-30 18:11:00 -05:00
'name' => isset ( $nav_menu [ 'name' ] ) ? $nav_menu [ 'name' ] : $nav_menu_location ,
)
);
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $nav_menu_setting_id ;
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
// @todo Add support for menu_item_parent.
$position = 0 ;
foreach ( $nav_menu [ 'items' ] as $nav_menu_item ) {
$nav_menu_item_setting_id = sprintf ( 'nav_menu_item[%d]' , $placeholder_id -- );
if ( ! isset ( $nav_menu_item [ 'position' ] ) ) {
$nav_menu_item [ 'position' ] = $position ++ ;
}
$nav_menu_item [ 'nav_menu_term_id' ] = $nav_menu_term_id ;
if ( isset ( $nav_menu_item [ 'object_id' ] ) ) {
if ( 'post_type' === $nav_menu_item [ 'type' ] && preg_match ( '/^{{(?P<symbol>.+)}}$/' , $nav_menu_item [ 'object_id' ], $matches ) && isset ( $posts [ $matches [ 'symbol' ] ] ) ) {
$nav_menu_item [ 'object_id' ] = $posts [ $matches [ 'symbol' ] ][ 'ID' ];
if ( empty ( $nav_menu_item [ 'title' ] ) ) {
2017-11-30 18:11:00 -05:00
$original_object = get_post ( $nav_menu_item [ 'object_id' ] );
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
$nav_menu_item [ 'title' ] = $original_object -> post_title ;
}
} else {
continue ;
}
} else {
$nav_menu_item [ 'object_id' ] = 0 ;
}
2016-11-15 04:03:32 -05:00
if ( empty ( $changeset_data [ $nav_menu_item_setting_id ] ) || ! empty ( $changeset_data [ $nav_menu_item_setting_id ][ 'starter_content' ] ) ) {
$this -> set_post_value ( $nav_menu_item_setting_id , $nav_menu_item );
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $nav_menu_item_setting_id ;
2016-11-15 04:03:32 -05:00
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
$setting_id = sprintf ( 'nav_menu_locations[%s]' , $nav_menu_location );
if ( empty ( $changeset_data [ $setting_id ] ) || ! empty ( $changeset_data [ $setting_id ][ 'starter_content' ] ) ) {
$this -> set_post_value ( $setting_id , $nav_menu_term_id );
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $setting_id ;
2016-11-15 04:03:32 -05:00
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
// Options.
foreach ( $options as $name => $value ) {
2019-10-15 12:43:01 -04:00
// Serialize the value to check for post symbols.
$value = maybe_serialize ( $value );
if ( is_serialized ( $value ) ) {
if ( preg_match ( '/s:\d+:"{{(?P<symbol>.+)}}"/' , $value , $matches ) ) {
if ( isset ( $posts [ $matches [ 'symbol' ] ] ) ) {
$symbol_match = $posts [ $matches [ 'symbol' ] ][ 'ID' ];
} elseif ( isset ( $attachment_ids [ $matches [ 'symbol' ] ] ) ) {
$symbol_match = $attachment_ids [ $matches [ 'symbol' ] ];
}
// If we have any symbol matches, update the values.
if ( isset ( $symbol_match ) ) {
// Replace found string matches with post IDs.
$value = str_replace ( $matches [ 0 ], " i: { $symbol_match } " , $value );
} else {
continue ;
}
}
} elseif ( preg_match ( '/^{{(?P<symbol>.+)}}$/' , $value , $matches ) ) {
2016-12-01 19:25:41 -05:00
if ( isset ( $posts [ $matches [ 'symbol' ] ] ) ) {
$value = $posts [ $matches [ 'symbol' ] ][ 'ID' ];
} elseif ( isset ( $attachment_ids [ $matches [ 'symbol' ] ] ) ) {
$value = $attachment_ids [ $matches [ 'symbol' ] ];
} else {
continue ;
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
2019-10-15 12:43:01 -04:00
// Unserialize values after checking for post symbols, so they can be properly referenced.
$value = maybe_unserialize ( $value );
2016-11-15 04:03:32 -05:00
if ( empty ( $changeset_data [ $name ] ) || ! empty ( $changeset_data [ $name ][ 'starter_content' ] ) ) {
$this -> set_post_value ( $name , $value );
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $name ;
2016-11-15 04:03:32 -05:00
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
// Theme mods.
foreach ( $theme_mods as $name => $value ) {
2019-10-15 12:43:01 -04:00
// Serialize the value to check for post symbols.
$value = maybe_serialize ( $value );
// Check if value was serialized.
if ( is_serialized ( $value ) ) {
if ( preg_match ( '/s:\d+:"{{(?P<symbol>.+)}}"/' , $value , $matches ) ) {
if ( isset ( $posts [ $matches [ 'symbol' ] ] ) ) {
$symbol_match = $posts [ $matches [ 'symbol' ] ][ 'ID' ];
} elseif ( isset ( $attachment_ids [ $matches [ 'symbol' ] ] ) ) {
$symbol_match = $attachment_ids [ $matches [ 'symbol' ] ];
}
// If we have any symbol matches, update the values.
if ( isset ( $symbol_match ) ) {
// Replace found string matches with post IDs.
$value = str_replace ( $matches [ 0 ], " i: { $symbol_match } " , $value );
} else {
continue ;
}
}
} elseif ( preg_match ( '/^{{(?P<symbol>.+)}}$/' , $value , $matches ) ) {
2016-12-01 19:25:41 -05:00
if ( isset ( $posts [ $matches [ 'symbol' ] ] ) ) {
$value = $posts [ $matches [ 'symbol' ] ][ 'ID' ];
} elseif ( isset ( $attachment_ids [ $matches [ 'symbol' ] ] ) ) {
$value = $attachment_ids [ $matches [ 'symbol' ] ];
} else {
continue ;
}
}
2019-10-15 12:43:01 -04:00
// Unserialize values after checking for post symbols, so they can be properly referenced.
$value = maybe_unserialize ( $value );
2016-12-01 19:25:41 -05:00
// Handle header image as special case since setting has a legacy format.
if ( 'header_image' === $name ) {
2017-11-30 18:11:00 -05:00
$name = 'header_image_data' ;
2016-12-01 19:25:41 -05:00
$metadata = wp_get_attachment_metadata ( $value );
if ( empty ( $metadata ) ) {
continue ;
}
$value = array (
'attachment_id' => $value ,
2017-11-30 18:11:00 -05:00
'url' => wp_get_attachment_url ( $value ),
'height' => $metadata [ 'height' ],
'width' => $metadata [ 'width' ],
2016-12-01 19:25:41 -05:00
);
} elseif ( 'background_image' === $name ) {
$value = wp_get_attachment_url ( $value );
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
if ( empty ( $changeset_data [ $name ] ) || ! empty ( $changeset_data [ $name ][ 'starter_content' ] ) ) {
$this -> set_post_value ( $name , $value );
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids [] = $name ;
2016-11-15 04:03:32 -05:00
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
2016-11-17 03:18:32 -05:00
if ( ! empty ( $this -> pending_starter_content_settings_ids ) ) {
2016-11-15 04:03:32 -05:00
if ( did_action ( 'customize_register' ) ) {
$this -> _save_starter_content_changeset ();
} else {
add_action ( 'customize_register' , array ( $this , '_save_starter_content_changeset' ), 1000 );
}
}
}
2016-12-01 19:25:41 -05:00
/**
2022-04-02 12:21:05 -04:00
* Prepares starter content attachments .
2016-12-01 19:25:41 -05:00
*
* Ensure that the attachments are valid and that they have slugs and file name / path .
*
* @ since 4.7 . 0
*
* @ param array $attachments Attachments .
* @ return array Prepared attachments .
*/
protected function prepare_starter_content_attachments ( $attachments ) {
$prepared_attachments = array ();
if ( empty ( $attachments ) ) {
return $prepared_attachments ;
}
// Such is The WordPress Way.
2020-02-06 01:33:11 -05:00
require_once ABSPATH . 'wp-admin/includes/file.php' ;
require_once ABSPATH . 'wp-admin/includes/media.php' ;
require_once ABSPATH . 'wp-admin/includes/image.php' ;
2016-12-01 19:25:41 -05:00
foreach ( $attachments as $symbol => $attachment ) {
// A file is required and URLs to files are not currently allowed.
if ( empty ( $attachment [ 'file' ] ) || preg_match ( '#^https?://$#' , $attachment [ 'file' ] ) ) {
continue ;
}
$file_path = null ;
if ( file_exists ( $attachment [ 'file' ] ) ) {
$file_path = $attachment [ 'file' ]; // Could be absolute path to file in plugin.
} elseif ( is_child_theme () && file_exists ( get_stylesheet_directory () . '/' . $attachment [ 'file' ] ) ) {
$file_path = get_stylesheet_directory () . '/' . $attachment [ 'file' ];
} elseif ( file_exists ( get_template_directory () . '/' . $attachment [ 'file' ] ) ) {
$file_path = get_template_directory () . '/' . $attachment [ 'file' ];
} else {
continue ;
}
2019-03-01 15:58:52 -05:00
$file_name = wp_basename ( $attachment [ 'file' ] );
2016-12-01 19:25:41 -05:00
// Skip file types that are not recognized.
$checked_filetype = wp_check_filetype ( $file_name );
if ( empty ( $checked_filetype [ 'type' ] ) ) {
continue ;
}
// Ensure post_name is set since not automatically derived from post_title for new auto-draft posts.
if ( empty ( $attachment [ 'post_name' ] ) ) {
if ( ! empty ( $attachment [ 'post_title' ] ) ) {
$attachment [ 'post_name' ] = sanitize_title ( $attachment [ 'post_title' ] );
} else {
$attachment [ 'post_name' ] = sanitize_title ( preg_replace ( '/\.\w+$/' , '' , $file_name ) );
}
}
2017-11-30 18:11:00 -05:00
$attachment [ 'file_name' ] = $file_name ;
$attachment [ 'file_path' ] = $file_path ;
2016-12-01 19:25:41 -05:00
$prepared_attachments [ $symbol ] = $attachment ;
}
return $prepared_attachments ;
}
2016-11-15 04:03:32 -05:00
/**
2022-04-02 12:21:05 -04:00
* Saves starter content changeset .
2016-11-15 04:03:32 -05:00
*
* @ since 4.7 . 0
*/
public function _save_starter_content_changeset () {
2016-11-17 03:18:32 -05:00
if ( empty ( $this -> pending_starter_content_settings_ids ) ) {
2016-11-15 04:03:32 -05:00
return ;
}
2017-11-30 18:11:00 -05:00
$this -> save_changeset_post (
array (
'data' => array_fill_keys ( $this -> pending_starter_content_settings_ids , array ( 'starter_content' => true ) ),
'starter_content' => true ,
)
);
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
$this -> saved_starter_content_changeset = true ;
2016-11-17 03:18:32 -05:00
$this -> pending_starter_content_settings_ids = array ();
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
2022-04-02 12:21:05 -04:00
* Gets dirty pre - sanitized setting values in the current customized state .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* The returned array consists of a merge of three sources :
* 1. If the theme is not currently active , then the base array is any stashed
* theme mods that were modified previously but never published .
* 2. The values from the current changeset , if it exists .
* 3. If the user can customize , the values parsed from the incoming
* `$_POST['customized']` JSON data .
* 4. Any programmatically - set post values via `WP_Customize_Manager::set_post_value()` .
*
* The name " unsanitized_post_values " is a carry - over from when the customized
* state was exclusively sourced from `$_POST['customized']` . Nevertheless ,
* the value returned will come from the current changeset post and from the
* incoming post data .
2012-04-30 11:46:17 -04:00
*
2015-02-03 05:15:21 -05:00
* @ since 4.1 . 1
2018-02-09 11:55:31 -05:00
* @ since 4.7 . 0 Added `$args` parameter and merging with changeset values and stashed theme mods .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ param array $args {
* Args .
2012-07-26 17:45:33 -04:00
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ type bool $exclude_changeset Whether the changeset values should also be excluded . Defaults to false .
* @ type bool $exclude_post_data Whether the post input values should also be excluded . Defaults to false when lacking the customize capability .
* }
2015-02-03 05:15:21 -05:00
* @ return array
2012-04-30 11:46:17 -04:00
*/
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
public function unsanitized_post_values ( $args = array () ) {
$args = array_merge (
array (
'exclude_changeset' => false ,
'exclude_post_data' => ! current_user_can ( 'customize' ),
),
$args
);
$values = array ();
// Let default values be from the stashed theme mods if doing a theme switch and if no changeset is present.
if ( ! $this -> is_theme_active () ) {
$stashed_theme_mods = get_option ( 'customize_stashed_theme_mods' );
2017-11-30 18:11:00 -05:00
$stylesheet = $this -> get_stylesheet ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( isset ( $stashed_theme_mods [ $stylesheet ] ) ) {
$values = array_merge ( $values , wp_list_pluck ( $stashed_theme_mods [ $stylesheet ], 'value' ) );
2015-02-03 05:15:21 -05:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
if ( ! $args [ 'exclude_changeset' ] ) {
foreach ( $this -> changeset_data () as $setting_id => $setting_params ) {
if ( ! array_key_exists ( 'value' , $setting_params ) ) {
continue ;
}
if ( isset ( $setting_params [ 'type' ] ) && 'theme_mod' === $setting_params [ 'type' ] ) {
2022-01-20 18:53:05 -05:00
// Ensure that theme mods values are only used if they were saved under the active theme.
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$namespace_pattern = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/' ;
if ( preg_match ( $namespace_pattern , $setting_id , $matches ) && $this -> get_stylesheet () === $matches [ 'stylesheet' ] ) {
$values [ $matches [ 'setting_id' ] ] = $setting_params [ 'value' ];
}
} else {
$values [ $setting_id ] = $setting_params [ 'value' ];
}
2015-02-03 05:15:21 -05:00
}
2012-04-30 11:46:17 -04:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! $args [ 'exclude_post_data' ] ) {
if ( ! isset ( $this -> _post_values ) ) {
if ( isset ( $_POST [ 'customized' ] ) ) {
$post_values = json_decode ( wp_unslash ( $_POST [ 'customized' ] ), true );
} else {
$post_values = array ();
}
if ( is_array ( $post_values ) ) {
$this -> _post_values = $post_values ;
} else {
$this -> _post_values = array ();
}
}
$values = array_merge ( $values , $this -> _post_values );
2015-02-03 05:15:21 -05:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return $values ;
2015-02-03 05:15:21 -05:00
}
2012-04-30 11:46:17 -04:00
2015-02-03 05:15:21 -05:00
/**
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* Returns the sanitized value for a given setting from the current customized state .
*
* The name " post_value " is a carry - over from when the customized state was exclusively
* sourced from `$_POST['customized']` . Nevertheless , the value returned will come
* from the current changeset post and from the incoming post data .
2015-02-03 05:15:21 -05:00
*
* @ since 3.4 . 0
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
* @ since 4.1 . 1 Introduced the `$default_value` parameter .
* @ since 4.6 . 0 `$default_value` is now returned early when the setting post value is invalid .
2016-07-20 12:57:32 -04:00
*
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
* @ see WP_REST_Server :: dispatch ()
2017-10-24 07:57:49 -04:00
* @ see WP_REST_Request :: sanitize_params ()
* @ see WP_REST_Request :: has_valid_params ()
2015-02-03 05:15:21 -05:00
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
* @ param WP_Customize_Setting $setting A WP_Customize_Setting derived object .
* @ param mixed $default_value Value returned if `$setting` has no post value ( added in 4.2 . 0 )
* or the post value is invalid ( added in 4.6 . 0 ) .
* @ return string | mixed Sanitized value or the `$default_value` provided .
2015-02-03 05:15:21 -05:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
public function post_value ( $setting , $default_value = null ) {
2015-02-03 05:15:21 -05:00
$post_values = $this -> unsanitized_post_values ();
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
if ( ! array_key_exists ( $setting -> id , $post_values ) ) {
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
return $default_value ;
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
}
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
2016-07-02 14:39:30 -04:00
$value = $post_values [ $setting -> id ];
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
$valid = $setting -> validate ( $value );
if ( is_wp_error ( $valid ) ) {
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
return $default_value ;
2015-02-03 05:15:21 -05:00
}
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
2016-07-02 14:39:30 -04:00
$value = $setting -> sanitize ( $value );
if ( is_null ( $value ) || is_wp_error ( $value ) ) {
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
return $default_value ;
2016-07-02 14:39:30 -04:00
}
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
return $value ;
2012-04-30 11:46:17 -04:00
}
2015-02-08 18:11:25 -05:00
/**
2022-04-02 12:21:05 -04:00
* Overrides a setting ' s value in the current customized state .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* The name " post_value " is a carry - over from when the customized state was
* exclusively sourced from `$_POST['customized']` .
2015-02-08 18:11:25 -05:00
*
* @ since 4.2 . 0
*
2015-04-05 11:03:29 -04:00
* @ param string $setting_id ID for the WP_Customize_Setting instance .
* @ param mixed $value Post value .
2015-02-08 18:11:25 -05:00
*/
public function set_post_value ( $setting_id , $value ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> unsanitized_post_values (); // Populate _post_values from $_POST['customized'].
2015-02-08 18:11:25 -05:00
$this -> _post_values [ $setting_id ] = $value ;
2015-11-20 21:52:27 -05:00
/**
2022-04-02 12:21:05 -04:00
* Announces when a specific setting ' s unsanitized post value has been set .
2015-11-20 21:52:27 -05:00
*
2016-05-02 00:00:28 -04:00
* Fires when the WP_Customize_Manager :: set_post_value () method is called .
2015-11-20 21:52:27 -05:00
*
* The dynamic portion of the hook name , `$setting_id` , refers to the setting ID .
*
* @ since 4.4 . 0
*
2021-07-30 15:35:58 -04:00
* @ param mixed $value Unsanitized setting post value .
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2015-11-20 21:52:27 -05:00
*/
do_action ( " customize_post_value_set_ { $setting_id } " , $value , $this );
/**
2022-04-02 12:21:05 -04:00
* Announces when any setting ' s unsanitized post value has been set .
2015-11-20 21:52:27 -05:00
*
2016-05-02 00:00:28 -04:00
* Fires when the WP_Customize_Manager :: set_post_value () method is called .
2015-11-20 21:52:27 -05:00
*
2016-02-23 14:18:27 -05:00
* This is useful for `WP_Customize_Setting` instances to watch
2015-11-20 21:52:27 -05:00
* in order to update a cached previewed value .
*
* @ since 4.4 . 0
*
* @ param string $setting_id Setting ID .
* @ param mixed $value Unsanitized setting post value .
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2015-11-20 21:52:27 -05:00
*/
do_action ( 'customize_post_value_set' , $setting_id , $value , $this );
2015-02-08 18:11:25 -05:00
}
2012-03-21 18:55:43 -04:00
/**
2022-04-02 12:21:05 -04:00
* Prints JavaScript settings .
2012-03-21 18:55:43 -04:00
*
* @ since 3.4 . 0
*/
public function customize_preview_init () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/*
* Now that Customizer previews are loaded into iframes via GET requests
* and natural URLs with transaction UUIDs added , we need to ensure that
* the responses are never cached by proxies . In practice , this will not
* be needed if the user is logged - in anyway . But if anonymous access is
* allowed then the auth cookies would not be sent and WordPress would
* not send no - cache headers by default .
*/
if ( ! headers_sent () ) {
nocache_headers ();
header ( 'X-Robots: noindex, nofollow, noarchive' );
2023-08-24 16:50:17 -04:00
header ( 'X-Robots-Tag: noindex, nofollow, noarchive' );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
Robots: Introduce Robots API.
This changeset introduces a filter-based Robots API, providing central control over the `robots` meta tag.
* Introduces `wp_robots()` function which should be called anywhere a `robots` meta tag should be included.
* Introduces `wp_robots` filter which allows adding or modifying directives for the `robots` meta tag. The `wp_robots()` function is entirely filter-based, i.e. if no filter is added to `wp_robots`, no directives will be present, and therefore the entire `robots` meta tag will be omitted.
* Introduces the following `wp_robots` filter functions which replace similar existing functions that were manually rendering a `robots` meta tag:
* `wp_robots_noindex()` replaces `noindex()`, which has been deprecated.
* `wp_robots_no_robots()` replaces `wp_no_robots()`, which has been deprecated.
* `wp_robots_sensitive_page()` replaces `wp_sensitive_page_meta()`, which has been deprecated. Its rendering of the `referrer` meta tag has been moved to another new function `wp_strict_cross_origin_referrer()`.
Migration to the new functions is straightforward. For example, a call to `add_action( 'wp_head', 'wp_no_robots' )` should be replaced with `add_filter( 'wp_robots', 'wp_robots_no_robots' )`.
Plugins and themes that render their own `robots` meta tags are encouraged to switch to rely on the `wp_robots` filter in order to use the central management layer now provided by WordPress core.
Props adamsilverstein, flixos90, timothyblynjacobs, westonruter.
See #51511.
Built from https://develop.svn.wordpress.org/trunk@49992
git-svn-id: http://core.svn.wordpress.org/trunk@49693 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-20 20:37:00 -05:00
add_filter ( 'wp_robots' , 'wp_robots_no_robots' );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
add_filter ( 'wp_headers' , array ( $this , 'filter_iframe_security_headers' ) );
/*
* If preview is being served inside the customizer preview iframe , and
* if the user doesn ' t have customize capability , then it is assumed
* that the user ' s session has expired and they need to re - authenticate .
*/
if ( $this -> messenger_channel && ! current_user_can ( 'customize' ) ) {
2020-07-25 12:01:07 -04:00
$this -> wp_die (
- 1 ,
sprintf (
/* translators: %s: customize_messenger_channel */
__ ( 'Unauthorized. You may remove the %s param to preview as frontend.' ),
'<code>customize_messenger_channel<code>'
)
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return ;
}
2012-06-26 14:48:18 -04:00
2012-03-21 18:55:43 -04:00
$this -> prepare_controls ();
2012-02-24 23:12:43 -05:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
add_filter ( 'wp_redirect' , array ( $this , 'add_state_query_params' ) );
2012-02-24 23:12:43 -05:00
wp_enqueue_script ( 'customize-preview' );
2017-01-25 22:47:41 -05:00
wp_enqueue_style ( 'customize-preview' );
2015-03-10 11:56:26 -04:00
add_action ( 'wp_head' , array ( $this , 'customize_preview_loading_style' ) );
2016-11-21 11:56:30 -05:00
add_action ( 'wp_head' , array ( $this , 'remove_frameless_preview_messenger_channel' ) );
2012-02-24 23:12:43 -05:00
add_action ( 'wp_footer' , array ( $this , 'customize_preview_settings' ), 20 );
2016-11-04 13:14:56 -04:00
add_filter ( 'get_edit_post_link' , '__return_empty_string' );
2012-03-21 18:55:43 -04:00
2014-03-06 09:11:15 -05:00
/**
* Fires once the Customizer preview has initialized and JavaScript
* settings have been printed .
*
* @ since 3.4 . 0
*
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2014-03-06 09:11:15 -05:00
*/
2012-04-30 13:20:32 -04:00
do_action ( 'customize_preview_init' , $this );
2012-02-24 23:12:43 -05:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
2020-08-10 20:34:08 -04:00
* Filters the X - Frame - Options and Content - Security - Policy headers to ensure frontend can load in customizer .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ param array $headers Headers .
* @ return array Headers .
*/
public function filter_iframe_security_headers ( $headers ) {
2019-01-14 01:38:51 -05:00
$headers [ 'X-Frame-Options' ] = 'SAMEORIGIN' ;
$headers [ 'Content-Security-Policy' ] = " frame-ancestors 'self' " ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return $headers ;
}
/**
2022-04-02 12:21:05 -04:00
* Adds customize state query params to a given URL if preview is allowed .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ see wp_redirect ()
* @ see WP_Customize_Manager :: get_allowed_url ()
*
* @ param string $url URL .
* @ return string URL .
*/
public function add_state_query_params ( $url ) {
$parsed_original_url = wp_parse_url ( $url );
2017-11-30 18:11:00 -05:00
$is_allowed = false ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
foreach ( $this -> get_allowed_urls () as $allowed_url ) {
$parsed_allowed_url = wp_parse_url ( $allowed_url );
2017-11-30 18:11:00 -05:00
$is_allowed = (
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$parsed_allowed_url [ 'scheme' ] === $parsed_original_url [ 'scheme' ]
&&
$parsed_allowed_url [ 'host' ] === $parsed_original_url [ 'host' ]
&&
Code Modernization: Replace usage of `strpos()` with `str_starts_with()`.
`str_starts_with()` was introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins with the given substring (needle).
WordPress core includes a polyfill for `str_starts_with()` on PHP < 8.0 as of WordPress 5.9.
This commit replaces `0 === strpos( ... )` with `str_starts_with()` in core files, making the code more readable and consistent, as well as improving performance.
While `strpos()` is slightly faster than the polyfill on PHP < 8.0, `str_starts_with()` is noticeably faster on PHP 8.0+, as it is optimized to avoid unnecessarily searching along the whole haystack if it does not find the needle.
Follow-up to [52039], [52040], [52326].
Props spacedmonkey, costdev, sabernhardt, mukesh27, desrosj, jorbin, TobiasBg, ayeshrajans, lgadzhev, SergeyBiryukov.
Fixes #58012.
Built from https://develop.svn.wordpress.org/trunk@55703
git-svn-id: http://core.svn.wordpress.org/trunk@55215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-02 11:45:22 -04:00
str_starts_with ( $parsed_original_url [ 'path' ], $parsed_allowed_url [ 'path' ] )
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
);
if ( $is_allowed ) {
break ;
}
}
if ( $is_allowed ) {
$query_params = array (
'customize_changeset_uuid' => $this -> changeset_uuid (),
);
if ( ! $this -> is_theme_active () ) {
$query_params [ 'customize_theme' ] = $this -> get_stylesheet ();
}
if ( $this -> messenger_channel ) {
$query_params [ 'customize_messenger_channel' ] = $this -> messenger_channel ;
}
$url = add_query_arg ( $query_params , $url );
}
return $url ;
}
2014-07-03 12:10:15 -04:00
/**
2022-04-02 12:21:05 -04:00
* Prevents sending a 404 status when returning the response for the customize
2016-07-09 20:51:30 -04:00
* preview , since it causes the jQuery Ajax to fail . Send 200 instead .
2014-07-03 12:10:15 -04:00
*
* @ since 4.0 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ deprecated 4.7 . 0
2014-07-03 12:10:15 -04:00
*/
public function customize_preview_override_404_status () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
_deprecated_function ( __METHOD__ , '4.7.0' );
2014-07-03 12:10:15 -04:00
}
2012-05-23 22:07:16 -04:00
/**
2022-04-02 12:21:05 -04:00
* Prints base element for preview frame .
2012-05-23 22:07:16 -04:00
*
* @ since 3.4 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ deprecated 4.7 . 0
2012-05-23 22:07:16 -04:00
*/
public function customize_preview_base () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
_deprecated_function ( __METHOD__ , '4.7.0' );
2012-05-23 22:07:16 -04:00
}
2012-03-21 18:55:43 -04:00
2012-06-05 08:26:57 -04:00
/**
2022-04-02 12:21:05 -04:00
* Prints a workaround to handle HTML5 tags in IE < 9.
2012-06-05 08:26:57 -04:00
*
* @ since 3.4 . 0
2016-09-25 00:35:32 -04:00
* @ deprecated 4.7 . 0 Customizer no longer supports IE8 , so all supported browsers recognize HTML5 .
2012-06-05 08:26:57 -04:00
*/
2016-09-25 00:35:32 -04:00
public function customize_preview_html5 () {
_deprecated_function ( __FUNCTION__ , '4.7.0' );
2012-06-05 08:26:57 -04:00
}
2015-03-10 11:56:26 -04:00
/**
2022-04-02 12:21:05 -04:00
* Prints CSS for loading indicators for the Customizer preview .
2015-03-10 11:56:26 -04:00
*
* @ since 4.2 . 0
*/
public function customize_preview_loading_style () {
2017-11-30 18:11:00 -05:00
?>
< style >
2015-03-10 11:56:26 -04:00
body . wp - customizer - unloading {
opacity : 0.25 ;
cursor : progress ! important ;
- webkit - transition : opacity 0.5 s ;
transition : opacity 0.5 s ;
}
body . wp - customizer - unloading * {
pointer - events : none ! important ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
form . customize - unpreviewable ,
form . customize - unpreviewable input ,
form . customize - unpreviewable select ,
form . customize - unpreviewable button ,
a . customize - unpreviewable ,
area . customize - unpreviewable {
cursor : not - allowed ! important ;
}
2017-11-30 18:11:00 -05:00
</ style >
< ? php
2015-03-10 11:56:26 -04:00
}
2016-11-21 11:56:30 -05:00
/**
2022-04-02 12:21:05 -04:00
* Removes customize_messenger_channel query parameter from the preview window when it is not in an iframe .
2016-11-21 11:56:30 -05:00
*
* This ensures that the admin bar will be shown . It also ensures that link navigation will
* work as expected since the parent frame is not being sent the URL to navigate to .
*
* @ since 4.7 . 0
*/
public function remove_frameless_preview_messenger_channel () {
if ( ! $this -> messenger_channel ) {
return ;
}
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
ob_start ();
2016-11-21 11:56:30 -05:00
?>
< script >
( function () {
if ( parent !== window ) {
return ;
}
2023-09-29 17:39:25 -04:00
const url = new URL ( location . href );
if ( url . searchParams . has ( 'customize_messenger_channel' ) ) {
url . searchParams . delete ( 'customize_messenger_channel' );
location . replace ( url );
2016-11-21 11:56:30 -05:00
}
} )();
</ script >
< ? php
2023-09-29 15:47:21 -04:00
wp_print_inline_script_tag ( wp_remove_surrounding_empty_script_tags ( ob_get_clean () ) );
2016-11-21 11:56:30 -05:00
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Prints JavaScript settings for preview frame .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*/
public function customize_preview_settings () {
2017-11-30 18:11:00 -05:00
$post_values = $this -> unsanitized_post_values ( array ( 'exclude_changeset' => true ) );
$setting_validities = $this -> validate_setting_values ( $post_values );
2016-06-14 15:17:28 -04:00
$exported_setting_validities = array_map ( array ( $this , 'prepare_setting_validity_for_js' ), $setting_validities );
2017-08-22 07:52:48 -04:00
// Note that the REQUEST_URI is not passed into home_url() since this breaks subdirectory installations.
2022-06-01 14:14:10 -04:00
$self_url = empty ( $_SERVER [ 'REQUEST_URI' ] ) ? home_url ( '/' ) : sanitize_url ( wp_unslash ( $_SERVER [ 'REQUEST_URI' ] ) );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$state_query_params = array (
'customize_theme' ,
'customize_changeset_uuid' ,
'customize_messenger_channel' ,
);
2017-11-30 18:11:00 -05:00
$self_url = remove_query_arg ( $state_query_params , $self_url );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
2017-11-30 18:11:00 -05:00
$allowed_urls = $this -> get_allowed_urls ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$allowed_hosts = array ();
foreach ( $allowed_urls as $allowed_url ) {
$parsed = wp_parse_url ( $allowed_url );
if ( empty ( $parsed [ 'host' ] ) ) {
continue ;
}
$host = $parsed [ 'host' ];
if ( ! empty ( $parsed [ 'port' ] ) ) {
$host .= ':' . $parsed [ 'port' ];
}
$allowed_hosts [] = $host ;
}
2016-12-08 14:32:59 -05:00
2023-01-30 05:27:16 -05:00
$switched_locale = switch_to_user_locale ( get_current_user_id () );
2017-11-30 18:11:00 -05:00
$l10n = array (
'shiftClickToEdit' => __ ( 'Shift-click to edit this element.' ),
2016-12-08 14:32:59 -05:00
'linkUnpreviewable' => __ ( 'This link is not live-previewable.' ),
'formUnpreviewable' => __ ( 'This form is not live-previewable.' ),
);
if ( $switched_locale ) {
restore_previous_locale ();
}
2012-02-24 23:12:43 -05:00
$settings = array (
2017-11-30 18:11:00 -05:00
'changeset' => array (
'uuid' => $this -> changeset_uuid (),
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
'autosaved' => $this -> autosaved (),
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
),
2017-11-30 18:11:00 -05:00
'timeouts' => array (
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'selectiveRefresh' => 250 ,
2017-11-30 18:11:00 -05:00
'keepAliveSend' => 1000 ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
),
2017-11-30 18:11:00 -05:00
'theme' => array (
2016-01-27 12:55:26 -05:00
'stylesheet' => $this -> get_stylesheet (),
'active' => $this -> is_theme_active (),
),
2017-11-30 18:11:00 -05:00
'url' => array (
'self' => $self_url ,
2022-06-01 14:14:10 -04:00
'allowed' => array_map ( 'sanitize_url' , $this -> get_allowed_urls () ),
2017-11-30 18:11:00 -05:00
'allowedHosts' => array_unique ( $allowed_hosts ),
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'isCrossDomain' => $this -> is_cross_domain (),
2016-01-27 12:55:26 -05:00
),
2017-11-30 18:11:00 -05:00
'channel' => $this -> messenger_channel ,
'activePanels' => array (),
'activeSections' => array (),
'activeControls' => array (),
2016-06-14 15:17:28 -04:00
'settingValidities' => $exported_setting_validities ,
2017-11-30 18:11:00 -05:00
'nonce' => current_user_can ( 'customize' ) ? $this -> get_nonces () : array (),
'l10n' => $l10n ,
'_dirty' => array_keys ( $post_values ),
2012-02-24 23:12:43 -05:00
);
2012-03-05 21:49:02 -05:00
2015-05-29 20:03:30 -04:00
foreach ( $this -> panels as $panel_id => $panel ) {
if ( $panel -> check_capabilities () ) {
$settings [ 'activePanels' ][ $panel_id ] = $panel -> active ();
foreach ( $panel -> sections as $section_id => $section ) {
if ( $section -> check_capabilities () ) {
$settings [ 'activeSections' ][ $section_id ] = $section -> active ();
}
}
2014-11-13 07:19:23 -05:00
}
Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.
* Introduce models for panels and sections.
* Introduce API to expand and focus a control, section or panel.
* Allow deep-linking to panels, sections, and controls inside of the Customizer.
* Clean up `accordion.js`, removing all Customizer-specific logic.
* Add initial unit tests for `wp.customize.Class` in `customize-base.js`.
https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.
props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.
Built from https://develop.svn.wordpress.org/trunk@30102
git-svn-id: http://core.svn.wordpress.org/trunk@30102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-29 18:51:22 -04:00
}
foreach ( $this -> sections as $id => $section ) {
2015-05-29 20:03:30 -04:00
if ( $section -> check_capabilities () ) {
$settings [ 'activeSections' ][ $id ] = $section -> active ();
}
Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.
* Introduce models for panels and sections.
* Introduce API to expand and focus a control, section or panel.
* Allow deep-linking to panels, sections, and controls inside of the Customizer.
* Clean up `accordion.js`, removing all Customizer-specific logic.
* Add initial unit tests for `wp.customize.Class` in `customize-base.js`.
https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.
props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.
Built from https://develop.svn.wordpress.org/trunk@30102
git-svn-id: http://core.svn.wordpress.org/trunk@30102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-29 18:51:22 -04:00
}
2014-07-09 19:58:16 -04:00
foreach ( $this -> controls as $id => $control ) {
2015-05-29 20:03:30 -04:00
if ( $control -> check_capabilities () ) {
$settings [ 'activeControls' ][ $id ] = $control -> active ();
}
2014-07-09 19:58:16 -04:00
}
2012-03-05 21:49:02 -05:00
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
ob_start ();
2012-02-24 23:12:43 -05:00
?>
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
< script >
2014-10-28 14:35:19 -04:00
var _wpCustomizeSettings = < ? php echo wp_json_encode ( $settings ); ?> ;
2015-09-17 15:42:26 -04:00
_wpCustomizeSettings . values = {};
( function ( v ) {
< ? php
/*
* Serialize settings separately from the initial _wpCustomizeSettings
* serialization in order to avoid a peak memory usage spike .
* @ todo We may not even need to export the values at all since the pane syncs them anyway .
*/
foreach ( $this -> settings as $id => $setting ) {
if ( $setting -> check_capabilities () ) {
printf (
" v[%s] = %s; \n " ,
wp_json_encode ( $id ),
wp_json_encode ( $setting -> js_value () )
);
}
}
?>
})( _wpCustomizeSettings . values );
2012-02-24 23:12:43 -05:00
</ script >
< ? php
2023-09-29 15:47:21 -04:00
wp_print_inline_script_tag ( wp_remove_surrounding_empty_script_tags ( ob_get_clean () ) );
2012-02-24 23:12:43 -05:00
}
2012-05-26 00:08:44 -04:00
/**
2014-10-15 13:21:19 -04:00
* Prints a signature so we can ensure the Customizer was properly executed .
2012-05-26 00:08:44 -04:00
*
* @ since 3.4 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ deprecated 4.7 . 0
2012-05-26 00:08:44 -04:00
*/
public function customize_preview_signature () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
_deprecated_function ( __METHOD__ , '4.7.0' );
2012-05-26 00:08:44 -04:00
}
2012-05-26 00:34:45 -04:00
/**
2014-10-15 13:21:19 -04:00
* Removes the signature in case we experience a case where the Customizer was not properly executed .
2012-05-26 00:34:45 -04:00
*
* @ since 3.4 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ deprecated 4.7 . 0
2015-05-21 18:05:24 -04:00
*
2022-04-22 06:56:13 -04:00
* @ param callable | null $callback Optional . Value passed through for { @ see 'wp_die_handler' } filter .
* Default null .
* @ return callable | null Value passed through for { @ see 'wp_die_handler' } filter .
2012-05-26 00:34:45 -04:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
public function remove_preview_signature ( $callback = null ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
_deprecated_function ( __METHOD__ , '4.7.0' );
2012-05-26 00:34:45 -04:00
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/class-wp-customize-manager.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `WP_Customize_Manager::post_value()`.
* Renames the `$return` parameter to `$callback` in `WP_Customize_Manager::remove_preview_signature()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53242
git-svn-id: http://core.svn.wordpress.org/trunk@52831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-04-22 06:31:15 -04:00
return $callback ;
2012-05-26 00:34:45 -04:00
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Determines whether it is a theme preview or not .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
* @ return bool True if it ' s a preview , false if not .
*/
public function is_preview () {
return ( bool ) $this -> previewing ;
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves the template name of the previewed theme .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
* @ return string Template name .
*/
public function get_template () {
2012-06-12 14:39:16 -04:00
return $this -> theme () -> get_template ();
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves the stylesheet name of the previewed theme .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
* @ return string Stylesheet name .
*/
public function get_stylesheet () {
2012-06-12 14:39:16 -04:00
return $this -> theme () -> get_stylesheet ();
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves the template root of the previewed theme .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
* @ return string Theme root .
*/
public function get_template_root () {
2012-04-17 17:43:47 -04:00
return get_raw_theme_root ( $this -> get_template (), true );
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves the stylesheet root of the previewed theme .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
* @ return string Theme root .
*/
public function get_stylesheet_root () {
2012-04-17 17:43:47 -04:00
return get_raw_theme_root ( $this -> get_stylesheet (), true );
2012-02-24 23:12:43 -05:00
}
/**
2022-01-20 18:53:05 -05:00
* Filters the active theme and return the name of the previewed theme .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
2020-07-22 20:48:06 -04:00
* @ param mixed $current_theme { @ internal Parameter is not used }
2012-02-24 23:12:43 -05:00
* @ return string Theme name .
*/
public function current_theme ( $current_theme ) {
2017-11-30 18:11:00 -05:00
return $this -> theme () -> display ( 'Name' );
2012-02-24 23:12:43 -05:00
}
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
/**
2016-07-20 12:57:32 -04:00
* Validates setting values .
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
*
* Validation is skipped for unregistered settings or for values that are
2016-08-21 20:41:31 -04:00
* already null since they will be skipped anyway . Sanitization is applied
* to values that pass validation , and values that become null or `WP_Error`
* after sanitizing are marked invalid .
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
*
* @ since 4.6 . 0
2016-07-20 12:57:32 -04:00
*
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
* @ see WP_REST_Request :: has_valid_params ()
2016-06-14 15:17:28 -04:00
* @ see WP_Customize_Setting :: validate ()
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
*
2016-08-21 20:41:31 -04:00
* @ param array $setting_values Mapping of setting IDs to values to validate and sanitize .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ param array $options {
* Options .
*
* @ type bool $validate_existence Whether a setting ' s existence will be checked .
* @ type bool $validate_capability Whether the setting capability will be checked .
* }
2016-06-14 15:17:28 -04:00
* @ return array Mapping of setting IDs to return value of validate method calls , either `true` or `WP_Error` .
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
*/
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
public function validate_setting_values ( $setting_values , $options = array () ) {
2017-11-30 18:11:00 -05:00
$options = wp_parse_args (
2018-08-16 21:51:36 -04:00
$options ,
array (
2017-11-30 18:11:00 -05:00
'validate_capability' => false ,
'validate_existence' => false ,
)
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
2016-06-14 15:17:28 -04:00
$validities = array ();
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
foreach ( $setting_values as $setting_id => $unsanitized_value ) {
$setting = $this -> get_setting ( $setting_id );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! $setting ) {
if ( $options [ 'validate_existence' ] ) {
$validities [ $setting_id ] = new WP_Error ( 'unrecognized' , __ ( 'Setting does not exist or is unrecognized.' ) );
}
continue ;
}
if ( $options [ 'validate_capability' ] && ! current_user_can ( $setting -> capability ) ) {
$validity = new WP_Error ( 'unauthorized' , __ ( 'Unauthorized to modify setting due to capability.' ) );
} else {
2016-11-19 17:39:33 -05:00
if ( is_null ( $unsanitized_value ) ) {
continue ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$validity = $setting -> validate ( $unsanitized_value );
}
2016-10-09 16:08:32 -04:00
if ( ! is_wp_error ( $validity ) ) {
/** This filter is documented in wp-includes/class-wp-customize-setting.php */
$late_validity = apply_filters ( " customize_validate_ { $setting -> id } " , new WP_Error (), $unsanitized_value , $setting );
2018-08-19 12:38:24 -04:00
if ( is_wp_error ( $late_validity ) && $late_validity -> has_errors () ) {
2016-10-09 16:08:32 -04:00
$validity = $late_validity ;
}
}
2016-07-02 14:39:30 -04:00
if ( ! is_wp_error ( $validity ) ) {
$value = $setting -> sanitize ( $unsanitized_value );
if ( is_null ( $value ) ) {
$validity = false ;
} elseif ( is_wp_error ( $value ) ) {
$validity = $value ;
}
}
if ( false === $validity ) {
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
$validity = new WP_Error ( 'invalid_value' , __ ( 'Invalid value.' ) );
}
2016-06-14 15:17:28 -04:00
$validities [ $setting_id ] = $validity ;
}
return $validities ;
}
/**
2016-07-20 12:57:32 -04:00
* Prepares setting validity for exporting to the client ( JS ) .
2016-06-14 15:17:28 -04:00
*
* Converts `WP_Error` instance into array suitable for passing into the
* `wp.customize.Notification` JS model .
*
* @ since 4.6 . 0
*
* @ param true | WP_Error $validity Setting validity .
2016-07-20 12:57:32 -04:00
* @ return true | array If `$validity` was a WP_Error , the error codes will be array - mapped
* to their respective `message` and `data` to pass into the
* `wp.customize.Notification` JS model .
2016-06-14 15:17:28 -04:00
*/
public function prepare_setting_validity_for_js ( $validity ) {
if ( is_wp_error ( $validity ) ) {
$notification = array ();
foreach ( $validity -> errors as $error_code => $error_messages ) {
$notification [ $error_code ] = array (
2020-10-18 13:27:06 -04:00
'message' => implode ( ' ' , $error_messages ),
2017-11-30 18:11:00 -05:00
'data' => $validity -> get_error_data ( $error_code ),
2016-06-14 15:17:28 -04:00
);
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
}
2016-06-14 15:17:28 -04:00
return $notification ;
} else {
return true ;
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
}
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Handles customize_save WP Ajax request to save / update a changeset .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ since 4.7 . 0 The semantics of this method have changed to update a changeset , optionally to also change the status and other attributes .
2012-02-24 23:12:43 -05:00
*/
public function save () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! is_user_logged_in () ) {
wp_send_json_error ( 'unauthenticated' );
}
2015-01-06 16:47:23 -05:00
if ( ! $this -> is_preview () ) {
wp_send_json_error ( 'not_preview' );
}
2012-02-24 23:12:43 -05:00
2015-01-06 16:47:23 -05:00
$action = 'save-customize_' . $this -> get_stylesheet ();
if ( ! check_ajax_referer ( $action , 'nonce' , false ) ) {
wp_send_json_error ( 'invalid_nonce' );
}
2012-02-24 23:12:43 -05:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$changeset_post_id = $this -> changeset_post_id ();
2017-11-30 18:11:00 -05:00
$is_new_changeset = empty ( $changeset_post_id );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( $is_new_changeset ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> create_posts ) ) {
wp_send_json_error ( 'cannot_create_changeset_post' );
}
} else {
if ( ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> edit_post , $changeset_post_id ) ) {
wp_send_json_error ( 'cannot_edit_changeset_post' );
}
}
if ( ! empty ( $_POST [ 'customize_changeset_data' ] ) ) {
$input_changeset_data = json_decode ( wp_unslash ( $_POST [ 'customize_changeset_data' ] ), true );
if ( ! is_array ( $input_changeset_data ) ) {
wp_send_json_error ( 'invalid_customize_changeset_data' );
}
} else {
$input_changeset_data = array ();
}
// Validate title.
$changeset_title = null ;
if ( isset ( $_POST [ 'customize_changeset_title' ] ) ) {
$changeset_title = sanitize_text_field ( wp_unslash ( $_POST [ 'customize_changeset_title' ] ) );
}
// Validate changeset status param.
2017-11-30 18:11:00 -05:00
$is_publish = null ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$changeset_status = null ;
if ( isset ( $_POST [ 'customize_changeset_status' ] ) ) {
$changeset_status = wp_unslash ( $_POST [ 'customize_changeset_status' ] );
if ( ! get_post_status_object ( $changeset_status ) || ! in_array ( $changeset_status , array ( 'draft' , 'pending' , 'publish' , 'future' ), true ) ) {
wp_send_json_error ( 'bad_customize_changeset_status' , 400 );
}
$is_publish = ( 'publish' === $changeset_status || 'future' === $changeset_status );
2016-12-01 19:02:44 -05:00
if ( $is_publish && ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> publish_posts ) ) {
wp_send_json_error ( 'changeset_publish_unauthorized' , 403 );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
}
/*
* Validate changeset date param . Date is assumed to be in local time for
* the WP if in MySQL format ( YYYY - MM - DD HH : MM : SS ) . Otherwise , the date
* is parsed with strtotime () so that ISO date format may be supplied
* or a string like " +10 minutes " .
*/
$changeset_date_gmt = null ;
if ( isset ( $_POST [ 'customize_changeset_date' ] ) ) {
$changeset_date = wp_unslash ( $_POST [ 'customize_changeset_date' ] );
if ( preg_match ( '/^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d$/' , $changeset_date ) ) {
2017-11-30 18:11:00 -05:00
$mm = substr ( $changeset_date , 5 , 2 );
$jj = substr ( $changeset_date , 8 , 2 );
$aa = substr ( $changeset_date , 0 , 4 );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$valid_date = wp_checkdate ( $mm , $jj , $aa , $changeset_date );
if ( ! $valid_date ) {
wp_send_json_error ( 'bad_customize_changeset_date' , 400 );
}
$changeset_date_gmt = get_gmt_from_date ( $changeset_date );
} else {
$timestamp = strtotime ( $changeset_date );
if ( ! $timestamp ) {
wp_send_json_error ( 'bad_customize_changeset_date' , 400 );
}
$changeset_date_gmt = gmdate ( 'Y-m-d H:i:s' , $timestamp );
}
}
2017-10-12 00:01:46 -04:00
$lock_user_id = null ;
2017-11-30 18:11:00 -05:00
$autosave = ! empty ( $_POST [ 'customize_changeset_autosave' ] );
2017-10-12 00:01:46 -04:00
if ( ! $is_new_changeset ) {
$lock_user_id = wp_check_post_lock ( $this -> changeset_post_id () );
}
// Force request to autosave when changeset is locked.
if ( $lock_user_id && ! $autosave ) {
2017-11-30 18:11:00 -05:00
$autosave = true ;
$changeset_status = null ;
2017-10-12 00:01:46 -04:00
$changeset_date_gmt = null ;
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( $autosave && ! defined ( 'DOING_AUTOSAVE' ) ) { // Back-compat.
define ( 'DOING_AUTOSAVE' , true );
}
2017-10-12 00:01:46 -04:00
$autosaved = false ;
2017-11-30 18:11:00 -05:00
$r = $this -> save_changeset_post (
array (
'status' => $changeset_status ,
'title' => $changeset_title ,
'date_gmt' => $changeset_date_gmt ,
'data' => $input_changeset_data ,
'autosave' => $autosave ,
)
);
2017-10-12 00:01:46 -04:00
if ( $autosave && ! is_wp_error ( $r ) ) {
$autosaved = true ;
}
// If the changeset was locked and an autosave request wasn't itself an error, then now explicitly return with a failure.
if ( $lock_user_id && ! is_wp_error ( $r ) ) {
$r = new WP_Error (
'changeset_locked' ,
__ ( 'Changeset is being edited by other user.' ),
array (
'lock_user' => $this -> get_lock_user_data ( $lock_user_id ),
)
);
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( is_wp_error ( $r ) ) {
2016-12-01 19:02:44 -05:00
$response = array (
'message' => $r -> get_error_message (),
2017-11-30 18:11:00 -05:00
'code' => $r -> get_error_code (),
2016-12-01 19:02:44 -05:00
);
if ( is_array ( $r -> get_error_data () ) ) {
$response = array_merge ( $response , $r -> get_error_data () );
} else {
$response [ 'data' ] = $r -> get_error_data ();
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
} else {
2017-11-30 18:11:00 -05:00
$response = $r ;
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
$changeset_post = get_post ( $this -> changeset_post_id () );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
// Dismiss all other auto-draft changeset posts for this user (they serve like autosave revisions), as there should only be one.
if ( $is_new_changeset ) {
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
$this -> dismiss_user_auto_draft_changesets ();
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
2020-02-09 23:12:07 -05:00
// Note that if the changeset status was publish, then it will get set to Trash if revisions are not supported.
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
$response [ 'changeset_status' ] = $changeset_post -> post_status ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( $is_publish && 'trash' === $response [ 'changeset_status' ] ) {
$response [ 'changeset_status' ] = 'publish' ;
}
2017-10-12 00:01:46 -04:00
if ( 'publish' !== $response [ 'changeset_status' ] ) {
$this -> set_changeset_lock ( $changeset_post -> ID );
}
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
if ( 'future' === $response [ 'changeset_status' ] ) {
$response [ 'changeset_date' ] = $changeset_post -> post_date ;
}
if ( 'publish' === $response [ 'changeset_status' ] || 'trash' === $response [ 'changeset_status' ] ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$response [ 'next_changeset_uuid' ] = wp_generate_uuid4 ();
}
}
2017-10-12 00:01:46 -04:00
if ( $autosave ) {
$response [ 'autosaved' ] = $autosaved ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( isset ( $response [ 'setting_validities' ] ) ) {
$response [ 'setting_validities' ] = array_map ( array ( $this , 'prepare_setting_validity_for_js' ), $response [ 'setting_validities' ] );
}
/**
* Filters response data for a successful customize_save Ajax request .
*
* This filter does not apply if there was a nonce or authentication failure .
*
* @ since 4.2 . 0
*
* @ param array $response Additional information passed back to the 'saved'
* event on `wp.customize` .
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*/
$response = apply_filters ( 'customize_save_response' , $response , $this );
if ( is_wp_error ( $r ) ) {
wp_send_json_error ( $response );
} else {
wp_send_json_success ( $response );
}
}
/**
2022-04-02 12:21:05 -04:00
* Saves the post for the loaded changeset .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ param array $args {
* Args for changeset post .
*
2016-11-15 04:03:32 -05:00
* @ type array $data Optional additional changeset data . Values will be merged on top of any existing post values .
* @ type string $status Post status . Optional . If supplied , the save will be transactional and a post revision will be allowed .
* @ type string $title Post title . Optional .
* @ type string $date_gmt Date in GMT . Optional .
* @ type int $user_id ID for user who is saving the changeset . Optional , defaults to the current user ID .
* @ type bool $starter_content Whether the data is starter content . If false ( default ), then $starter_content will be cleared for any $data being saved .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
* @ type bool $autosave Whether this is a request to create an autosave revision .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* }
*
* @ return array | WP_Error Returns array on success and WP_Error with array data on error .
*/
2021-10-18 13:52:58 -04:00
public function save_changeset_post ( $args = array () ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$args = array_merge (
array (
2017-11-30 18:11:00 -05:00
'status' => null ,
'title' => null ,
'data' => array (),
'date_gmt' => null ,
'user_id' => get_current_user_id (),
2016-11-15 04:03:32 -05:00
'starter_content' => false ,
2017-11-30 18:11:00 -05:00
'autosave' => false ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
),
$args
);
2017-11-30 18:11:00 -05:00
$changeset_post_id = $this -> changeset_post_id ();
2016-11-09 02:03:30 -05:00
$existing_changeset_data = array ();
if ( $changeset_post_id ) {
2016-12-01 19:02:44 -05:00
$existing_status = get_post_status ( $changeset_post_id );
if ( 'publish' === $existing_status || 'trash' === $existing_status ) {
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
return new WP_Error (
'changeset_already_published' ,
2017-10-08 05:25:55 -04:00
__ ( 'The previous set of changes has already been published. Please try saving your current set of changes again.' ),
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
array (
'next_changeset_uuid' => wp_generate_uuid4 (),
)
);
2016-12-01 19:02:44 -05:00
}
2016-11-09 02:03:30 -05:00
$existing_changeset_data = $this -> get_changeset_post_data ( $changeset_post_id );
2017-07-06 03:05:43 -04:00
if ( is_wp_error ( $existing_changeset_data ) ) {
return $existing_changeset_data ;
}
2016-11-09 02:03:30 -05:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
2016-12-01 19:02:44 -05:00
// Fail if attempting to publish but publish hook is missing.
if ( 'publish' === $args [ 'status' ] && false === has_action ( 'transition_post_status' , '_wp_customize_publish_changeset' ) ) {
return new WP_Error ( 'missing_publish_callback' );
}
// Validate date.
$now = gmdate ( 'Y-m-d H:i:59' );
if ( $args [ 'date_gmt' ] ) {
$is_future_dated = ( mysql2date ( 'U' , $args [ 'date_gmt' ], false ) > mysql2date ( 'U' , $now , false ) );
if ( ! $is_future_dated ) {
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
return new WP_Error ( 'not_future_date' , __ ( 'You must supply a future date to schedule.' ) ); // Only future dates are allowed.
2016-12-01 19:02:44 -05:00
}
if ( ! $this -> is_theme_active () && ( 'future' === $args [ 'status' ] || $is_future_dated ) ) {
return new WP_Error ( 'cannot_schedule_theme_switches' ); // This should be allowed in the future, when theme is a regular setting.
}
$will_remain_auto_draft = ( ! $args [ 'status' ] && ( ! $changeset_post_id || 'auto-draft' === get_post_status ( $changeset_post_id ) ) );
if ( $will_remain_auto_draft ) {
return new WP_Error ( 'cannot_supply_date_for_auto_draft_changeset' );
}
} elseif ( $changeset_post_id && 'future' === $args [ 'status' ] ) {
// Fail if the new status is future but the existing post's date is not in the future.
$changeset_post = get_post ( $changeset_post_id );
if ( mysql2date ( 'U' , $changeset_post -> post_date_gmt , false ) <= mysql2date ( 'U' , $now , false ) ) {
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
return new WP_Error ( 'not_future_date' , __ ( 'You must supply a future date to schedule.' ) );
2016-12-01 19:02:44 -05:00
}
}
2017-09-11 13:50:44 -04:00
if ( ! empty ( $is_future_dated ) && 'publish' === $args [ 'status' ] ) {
$args [ 'status' ] = 'future' ;
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
// Validate autosave param. See _wp_post_revision_fields() for why these fields are disallowed.
if ( $args [ 'autosave' ] ) {
if ( $args [ 'date_gmt' ] ) {
return new WP_Error ( 'illegal_autosave_with_date_gmt' );
} elseif ( $args [ 'status' ] ) {
return new WP_Error ( 'illegal_autosave_with_status' );
} elseif ( $args [ 'user_id' ] && get_current_user_id () !== $args [ 'user_id' ] ) {
return new WP_Error ( 'illegal_autosave_with_non_current_user' );
}
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// The request was made via wp.customize.previewer.save().
$update_transactionally = ( bool ) $args [ 'status' ];
2017-11-30 18:11:00 -05:00
$allow_revision = ( bool ) $args [ 'status' ];
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Amend post values with any supplied data.
foreach ( $args [ 'data' ] as $setting_id => $setting_params ) {
2017-08-12 17:21:48 -04:00
if ( is_array ( $setting_params ) && array_key_exists ( 'value' , $setting_params ) ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> set_post_value ( $setting_id , $setting_params [ 'value' ] ); // Add to post values so that they can be validated and sanitized.
}
}
// Note that in addition to post data, this will include any stashed theme mods.
2017-11-30 18:11:00 -05:00
$post_values = $this -> unsanitized_post_values (
array (
'exclude_changeset' => true ,
'exclude_post_data' => false ,
)
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> add_dynamic_settings ( array_keys ( $post_values ) ); // Ensure settings get created even if they lack an input value.
2016-11-09 02:03:30 -05:00
/*
* Get list of IDs for settings that have values different from what is currently
* saved in the changeset . By skipping any values that are already the same , the
* subset of changed settings can be passed into validate_setting_values to prevent
* an underprivileged modifying a single setting for which they have the capability
* from being blocked from saving . This also prevents a user from touching of the
* previous saved settings and overriding the associated user_id if they made no change .
*/
$changed_setting_ids = array ();
foreach ( $post_values as $setting_id => $setting_value ) {
$setting = $this -> get_setting ( $setting_id );
if ( $setting && 'theme_mod' === $setting -> type ) {
$prefixed_setting_id = $this -> get_stylesheet () . '::' . $setting -> id ;
} else {
$prefixed_setting_id = $setting_id ;
}
$is_value_changed = (
! isset ( $existing_changeset_data [ $prefixed_setting_id ] )
||
! array_key_exists ( 'value' , $existing_changeset_data [ $prefixed_setting_id ] )
||
$existing_changeset_data [ $prefixed_setting_id ][ 'value' ] !== $setting_value
);
if ( $is_value_changed ) {
$changed_setting_ids [] = $setting_id ;
}
}
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
/**
* Fires before save validation happens .
*
2016-07-20 12:57:32 -04:00
* Plugins can add just - in - time { @ see 'customize_validate_{$this->ID}' } filters
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
* at this point to catch any settings registered after `customize_register` .
2016-07-22 09:51:28 -04:00
* The dynamic portion of the hook name , `$this->ID` refers to the setting ID .
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
*
* @ since 4.6 . 0
*
2021-07-30 15:35:58 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
*/
do_action ( 'customize_save_validation_before' , $this );
// Validate settings.
2017-11-30 18:11:00 -05:00
$validated_values = array_merge (
2016-11-19 17:39:33 -05:00
array_fill_keys ( array_keys ( $args [ 'data' ] ), null ), // Make sure existence/capability checks are done on value-less setting updates.
$post_values
);
2017-11-30 18:11:00 -05:00
$setting_validities = $this -> validate_setting_values (
2018-08-16 21:51:36 -04:00
$validated_values ,
array (
2017-11-30 18:11:00 -05:00
'validate_capability' => true ,
'validate_existence' => true ,
)
);
2016-06-14 15:17:28 -04:00
$invalid_setting_count = count ( array_filter ( $setting_validities , 'is_wp_error' ) );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/*
* Short - circuit if there are invalid settings the update is transactional .
* A changeset update is transactional when a status is supplied in the request .
*/
if ( $update_transactionally && $invalid_setting_count > 0 ) {
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
$response = array (
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'setting_validities' => $setting_validities ,
2019-09-02 20:41:05 -04:00
/* translators: %s: Number of invalid settings. */
2017-11-30 18:11:00 -05:00
'message' => sprintf ( _n ( 'Unable to save due to %s invalid setting.' , 'Unable to save due to %s invalid settings.' , $invalid_setting_count ), number_format_i18n ( $invalid_setting_count ) ),
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return new WP_Error ( 'transaction_fail' , '' , $response );
}
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Obtain/merge data for changeset.
$original_changeset_data = $this -> get_changeset_post_data ( $changeset_post_id );
2017-11-30 18:11:00 -05:00
$data = $original_changeset_data ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( is_wp_error ( $data ) ) {
$data = array ();
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Ensure that all post values are included in the changeset data.
foreach ( $post_values as $setting_id => $post_value ) {
if ( ! isset ( $args [ 'data' ][ $setting_id ] ) ) {
$args [ 'data' ][ $setting_id ] = array ();
}
if ( ! isset ( $args [ 'data' ][ $setting_id ][ 'value' ] ) ) {
$args [ 'data' ][ $setting_id ][ 'value' ] = $post_value ;
}
}
foreach ( $args [ 'data' ] as $setting_id => $setting_params ) {
$setting = $this -> get_setting ( $setting_id );
if ( ! $setting || ! $setting -> check_capabilities () ) {
continue ;
}
// Skip updating changeset for invalid setting values.
if ( isset ( $setting_validities [ $setting_id ] ) && is_wp_error ( $setting_validities [ $setting_id ] ) ) {
continue ;
}
$changeset_setting_id = $setting_id ;
if ( 'theme_mod' === $setting -> type ) {
$changeset_setting_id = sprintf ( '%s::%s' , $this -> get_stylesheet (), $setting_id );
}
if ( null === $setting_params ) {
// Remove setting from changeset entirely.
unset ( $data [ $changeset_setting_id ] );
} else {
2016-11-19 17:39:33 -05:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! isset ( $data [ $changeset_setting_id ] ) ) {
$data [ $changeset_setting_id ] = array ();
}
2016-11-15 04:03:32 -05:00
2016-11-19 17:39:33 -05:00
// Merge any additional setting params that have been supplied with the existing params.
$merged_setting_params = array_merge ( $data [ $changeset_setting_id ], $setting_params );
// Skip updating setting params if unchanged (ensuring the user_id is not overwritten).
if ( $data [ $changeset_setting_id ] === $merged_setting_params ) {
continue ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$data [ $changeset_setting_id ] = array_merge (
2016-11-19 17:39:33 -05:00
$merged_setting_params ,
2016-11-09 02:03:30 -05:00
array (
2017-11-30 18:11:00 -05:00
'type' => $setting -> type ,
'user_id' => $args [ 'user_id' ],
2017-10-12 00:01:46 -04:00
'date_modified_gmt' => current_time ( 'mysql' , true ),
2016-11-09 02:03:30 -05:00
)
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
);
2016-11-15 04:03:32 -05:00
// Clear starter_content flag in data if changeset is not explicitly being updated for starter content.
if ( empty ( $args [ 'starter_content' ] ) ) {
unset ( $data [ $changeset_setting_id ][ 'starter_content' ] );
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
}
$filter_context = array (
2017-11-30 18:11:00 -05:00
'uuid' => $this -> changeset_uuid (),
'title' => $args [ 'title' ],
'status' => $args [ 'status' ],
'date_gmt' => $args [ 'date_gmt' ],
'post_id' => $changeset_post_id ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'previous_data' => is_wp_error ( $original_changeset_data ) ? array () : $original_changeset_data ,
2017-11-30 18:11:00 -05:00
'manager' => $this ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
);
/**
* Filters the settings ' data that will be persisted into the changeset .
*
* Plugins may amend additional data ( such as additional meta for settings ) into the changeset with this filter .
*
* @ since 4.7 . 0
*
* @ param array $data Updated changeset data , mapping setting IDs to arrays containing a $value item and optionally other metadata .
* @ param array $context {
* Filter context .
*
* @ type string $uuid Changeset UUID .
* @ type string $title Requested title for the changeset post .
* @ type string $status Requested status for the changeset post .
* @ type string $date_gmt Requested date for the changeset post in MySQL format and GMT timezone .
* @ type int | false $post_id Post ID for the changeset , or false if it doesn ' t exist yet .
* @ type array $previous_data Previous data contained in the changeset .
* @ type WP_Customize_Manager $manager Manager instance .
* }
*/
$data = apply_filters ( 'customize_changeset_save_data' , $data , $filter_context );
// Switch theme if publishing changes now.
if ( 'publish' === $args [ 'status' ] && ! $this -> is_theme_active () ) {
// Temporarily stop previewing the theme to allow switch_themes() to operate properly.
2012-04-25 11:44:06 -04:00
$this -> stop_previewing_theme ();
2012-06-26 01:21:04 -04:00
switch_theme ( $this -> get_stylesheet () );
2014-04-14 18:46:16 -04:00
update_option ( 'theme_switched_via_customizer' , true );
2012-04-25 11:44:06 -04:00
$this -> start_previewing_theme ();
2012-02-24 23:12:43 -05:00
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Gather the data for wp_insert_post()/wp_update_post().
2019-09-20 16:08:57 -04:00
$post_array = array (
// JSON_UNESCAPED_SLASHES is only to improve readability as slashes needn't be escaped in storage.
'post_content' => wp_json_encode ( $data , JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT ),
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
);
if ( $args [ 'title' ] ) {
$post_array [ 'post_title' ] = $args [ 'title' ];
}
if ( $changeset_post_id ) {
$post_array [ 'ID' ] = $changeset_post_id ;
} else {
2017-11-30 18:11:00 -05:00
$post_array [ 'post_type' ] = 'customize_changeset' ;
$post_array [ 'post_name' ] = $this -> changeset_uuid ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$post_array [ 'post_status' ] = 'auto-draft' ;
}
if ( $args [ 'status' ] ) {
$post_array [ 'post_status' ] = $args [ 'status' ];
}
2016-12-01 19:02:44 -05:00
// Reset post date to now if we are publishing, otherwise pass post_date_gmt and translate for post_date.
if ( 'publish' === $args [ 'status' ] ) {
$post_array [ 'post_date_gmt' ] = '0000-00-00 00:00:00' ;
2017-11-30 18:11:00 -05:00
$post_array [ 'post_date' ] = '0000-00-00 00:00:00' ;
2016-12-01 19:02:44 -05:00
} elseif ( $args [ 'date_gmt' ] ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$post_array [ 'post_date_gmt' ] = $args [ 'date_gmt' ];
2017-11-30 18:11:00 -05:00
$post_array [ 'post_date' ] = get_date_from_gmt ( $args [ 'date_gmt' ] );
2017-02-05 01:39:41 -05:00
} elseif ( $changeset_post_id && 'auto-draft' === get_post_status ( $changeset_post_id ) ) {
/*
* Keep bumping the date for the auto - draft whenever it is modified ;
* this extends its life , preserving it from garbage - collection via
* wp_delete_auto_drafts () .
*/
2017-11-30 18:11:00 -05:00
$post_array [ 'post_date' ] = current_time ( 'mysql' );
2017-02-05 01:39:41 -05:00
$post_array [ 'post_date_gmt' ] = '' ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
$this -> store_changeset_revision = $allow_revision ;
add_filter ( 'wp_save_post_revision_post_has_changed' , array ( $this , '_filter_revision_post_has_changed' ), 5 , 3 );
2020-04-29 11:14:10 -04:00
/*
* Update the changeset post . The publish_customize_changeset action will cause the settings in the
* changeset to be saved via WP_Customize_Setting :: save () . Updating a post with publish status will
* trigger WP_Customize_Manager :: publish_changeset_values () .
*/
add_filter ( 'wp_insert_post_data' , array ( $this , 'preserve_insert_changeset_post_content' ), 5 , 3 );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( $changeset_post_id ) {
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( $args [ 'autosave' ] && 'auto-draft' !== get_post_status ( $changeset_post_id ) ) {
// See _wp_translate_postdata() for why this is required as it will use the edit_post meta capability.
add_filter ( 'map_meta_cap' , array ( $this , 'grant_edit_post_capability_for_changeset' ), 10 , 4 );
2020-01-28 19:45:18 -05:00
2017-11-30 18:11:00 -05:00
$post_array [ 'post_ID' ] = $post_array [ 'ID' ];
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
$post_array [ 'post_type' ] = 'customize_changeset' ;
2020-01-28 19:45:18 -05:00
$r = wp_create_post_autosave ( wp_slash ( $post_array ) );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
remove_filter ( 'map_meta_cap' , array ( $this , 'grant_edit_post_capability_for_changeset' ), 10 );
} else {
$post_array [ 'edit_date' ] = true ; // Prevent date clearing.
2020-01-28 19:45:18 -05:00
$r = wp_update_post ( wp_slash ( $post_array ), true );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
2018-01-29 19:21:30 -05:00
// Delete autosave revision for user when the changeset is updated.
if ( ! empty ( $args [ 'user_id' ] ) ) {
$autosave_draft = wp_get_post_autosave ( $changeset_post_id , $args [ 'user_id' ] );
if ( $autosave_draft ) {
wp_delete_post ( $autosave_draft -> ID , true );
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
} else {
$r = wp_insert_post ( wp_slash ( $post_array ), true );
if ( ! is_wp_error ( $r ) ) {
$this -> _changeset_post_id = $r ; // Update cached post ID for the loaded changeset.
}
}
2020-04-29 11:14:10 -04:00
remove_filter ( 'wp_insert_post_data' , array ( $this , 'preserve_insert_changeset_post_content' ), 5 );
2019-01-29 16:29:50 -05:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> _changeset_data = null ; // Reset so WP_Customize_Manager::changeset_data() will re-populate with updated contents.
remove_filter ( 'wp_save_post_revision_post_has_changed' , array ( $this , '_filter_revision_post_has_changed' ) );
2016-11-19 17:39:33 -05:00
$response = array (
'setting_validities' => $setting_validities ,
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( is_wp_error ( $r ) ) {
$response [ 'changeset_post_save_failure' ] = $r -> get_error_code ();
return new WP_Error ( 'changeset_post_save_failure' , '' , $response );
}
return $response ;
}
2020-04-29 11:14:10 -04:00
/**
2022-04-02 12:21:05 -04:00
* Preserves the initial JSON post_content passed to save into the post .
2020-04-29 11:14:10 -04:00
*
* This is needed to prevent KSES and other { @ see 'content_save_pre' } filters
* from corrupting JSON data .
*
* Note that WP_Customize_Manager :: validate_setting_values () have already
* run on the setting values being serialized as JSON into the post content
* so it is pre - sanitized .
*
* Also , the sanitization logic is re - run through the respective
* WP_Customize_Setting :: sanitize () method when being read out of the
* changeset , via WP_Customize_Manager :: post_value (), and this sanitized
* value will also be sent into WP_Customize_Setting :: update () for
* persisting to the DB .
*
* Multiple users can collaborate on a single changeset , where one user may
* have the unfiltered_html capability but another may not . A user with
* unfiltered_html may add a script tag to some field which needs to be kept
* intact even when another user updates the changeset to modify another field
* when they do not have unfiltered_html .
*
* @ since 5.4 . 1
*
* @ param array $data An array of slashed and processed post data .
* @ param array $postarr An array of sanitized ( and slashed ) but otherwise unmodified post data .
* @ param array $unsanitized_postarr An array of slashed yet * unsanitized * and unprocessed post data as originally passed to wp_insert_post () .
* @ return array Filtered post data .
*/
public function preserve_insert_changeset_post_content ( $data , $postarr , $unsanitized_postarr ) {
if (
isset ( $data [ 'post_type' ] ) &&
isset ( $unsanitized_postarr [ 'post_content' ] ) &&
'customize_changeset' === $data [ 'post_type' ] ||
(
'revision' === $data [ 'post_type' ] &&
! empty ( $data [ 'post_parent' ] ) &&
'customize_changeset' === get_post_type ( $data [ 'post_parent' ] )
)
) {
$data [ 'post_content' ] = $unsanitized_postarr [ 'post_content' ];
}
return $data ;
}
2017-10-11 01:42:49 -04:00
/**
2022-04-02 12:21:05 -04:00
* Trashes or deletes a changeset post .
2017-10-11 01:42:49 -04:00
*
* The following re - formulates the logic from `wp_trash_post()` as done in
* `wp_publish_post()` . The reason for bypassing `wp_trash_post()` is that it
* will mutate the the `post_content` and the `post_name` when they should be
* untouched .
*
* @ since 4.9 . 0
2020-06-16 17:07:14 -04:00
*
2017-10-11 01:42:49 -04:00
* @ see wp_trash_post ()
2020-06-16 17:07:14 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2017-10-11 01:42:49 -04:00
*
* @ param int | WP_Post $post The changeset post .
* @ return mixed A WP_Post object for the trashed post or an empty value on failure .
*/
public function trash_changeset_post ( $post ) {
global $wpdb ;
$post = get_post ( $post );
if ( ! ( $post instanceof WP_Post ) ) {
return $post ;
}
$post_id = $post -> ID ;
if ( ! EMPTY_TRASH_DAYS ) {
return wp_delete_post ( $post_id , true );
}
if ( 'trash' === get_post_status ( $post ) ) {
return false ;
}
2024-01-03 11:22:20 -05:00
$previous_status = $post -> post_status ;
2017-10-11 01:42:49 -04:00
/** This filter is documented in wp-includes/post.php */
2024-01-03 11:22:20 -05:00
$check = apply_filters ( 'pre_trash_post' , null , $post , $previous_status );
2017-10-11 01:42:49 -04:00
if ( null !== $check ) {
return $check ;
}
/** This action is documented in wp-includes/post.php */
2024-01-03 11:22:20 -05:00
do_action ( 'wp_trash_post' , $post_id , $previous_status );
2017-10-11 01:42:49 -04:00
2024-01-03 11:22:20 -05:00
add_post_meta ( $post_id , '_wp_trash_meta_status' , $previous_status );
2017-10-11 01:42:49 -04:00
add_post_meta ( $post_id , '_wp_trash_meta_time' , time () );
$new_status = 'trash' ;
$wpdb -> update ( $wpdb -> posts , array ( 'post_status' => $new_status ), array ( 'ID' => $post -> ID ) );
clean_post_cache ( $post -> ID );
$post -> post_status = $new_status ;
2024-01-03 11:22:20 -05:00
wp_transition_post_status ( $new_status , $previous_status , $post );
2017-10-11 01:42:49 -04:00
2018-07-25 16:57:25 -04:00
/** This action is documented in wp-includes/post.php */
do_action ( " edit_post_ { $post -> post_type } " , $post -> ID , $post );
2017-10-11 01:42:49 -04:00
/** This action is documented in wp-includes/post.php */
do_action ( 'edit_post' , $post -> ID , $post );
/** This action is documented in wp-includes/post.php */
do_action ( " save_post_ { $post -> post_type } " , $post -> ID , $post , true );
/** This action is documented in wp-includes/post.php */
do_action ( 'save_post' , $post -> ID , $post , true );
/** This action is documented in wp-includes/post.php */
do_action ( 'wp_insert_post' , $post -> ID , $post , true );
2020-12-01 15:47:06 -05:00
wp_after_insert_post ( get_post ( $post_id ), true , $post );
REST API, Posts: Add a hook to fire once a post, its terms and meta update.
Introduces the action `wp_after_insert_post` inside a wrapper function of the same name. This hook allows plugin developers to access a posts full data (including its terms and meta data) regardless of the workflow used to save it.
A new parameter is introduced to `wp_insert_post()` to indicate whether the hook should be fired within the function call or will be fired afterward.
Props aristath, Collizo4sky, danielbachhuber, joyously, kadamwhite, kraftbj, markparnell, mikeschroder, noisysocks, peterwilsoncc, SergeyBiryukov, talldanwp, thewebprincess, TimothyBlynJacobs.
Fixes #45114.
Built from https://develop.svn.wordpress.org/trunk@49172
git-svn-id: http://core.svn.wordpress.org/trunk@48934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-15 23:34:08 -04:00
2017-10-11 01:42:49 -04:00
wp_trash_post_comments ( $post_id );
/** This action is documented in wp-includes/post.php */
2024-01-03 11:22:20 -05:00
do_action ( 'trashed_post' , $post_id , $previous_status );
2017-10-11 01:42:49 -04:00
return $post ;
}
2017-10-01 23:37:46 -04:00
/**
2022-04-02 12:21:05 -04:00
* Handles request to trash a changeset .
2017-10-01 23:37:46 -04:00
*
* @ since 4.9 . 0
*/
public function handle_changeset_trash_request () {
if ( ! is_user_logged_in () ) {
wp_send_json_error ( 'unauthenticated' );
}
if ( ! $this -> is_preview () ) {
wp_send_json_error ( 'not_preview' );
}
if ( ! check_ajax_referer ( 'trash_customize_changeset' , 'nonce' , false ) ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'code' => 'invalid_nonce' ,
'message' => __ ( 'There was an authentication problem. Please reload and try again.' ),
)
);
2017-10-01 23:37:46 -04:00
}
$changeset_post_id = $this -> changeset_post_id ();
if ( ! $changeset_post_id ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'message' => __ ( 'No changes saved yet, so there is nothing to trash.' ),
'code' => 'non_existent_changeset' ,
)
);
2017-10-01 23:37:46 -04:00
return ;
}
2020-06-29 06:33:08 -04:00
if ( $changeset_post_id ) {
if ( ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> delete_post , $changeset_post_id ) ) {
wp_send_json_error (
array (
'code' => 'changeset_trash_unauthorized' ,
'message' => __ ( 'Unable to trash changes.' ),
)
);
}
$lock_user = ( int ) wp_check_post_lock ( $changeset_post_id );
if ( $lock_user && get_current_user_id () !== $lock_user ) {
wp_send_json_error (
array (
'code' => 'changeset_locked' ,
'message' => __ ( 'Changeset is being edited by other user.' ),
'lockUser' => $this -> get_lock_user_data ( $lock_user ),
)
);
}
2017-10-01 23:37:46 -04:00
}
if ( 'trash' === get_post_status ( $changeset_post_id ) ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'message' => __ ( 'Changes have already been trashed.' ),
'code' => 'changeset_already_trashed' ,
)
);
2017-10-01 23:37:46 -04:00
return ;
}
2017-10-11 01:42:49 -04:00
$r = $this -> trash_changeset_post ( $changeset_post_id );
2017-10-01 23:37:46 -04:00
if ( ! ( $r instanceof WP_Post ) ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'code' => 'changeset_trash_failure' ,
'message' => __ ( 'Unable to trash changes.' ),
)
);
2017-10-01 23:37:46 -04:00
}
2017-11-30 18:11:00 -05:00
wp_send_json_success (
array (
'message' => __ ( 'Changes trashed successfully.' ),
)
);
2017-10-01 23:37:46 -04:00
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
/**
2022-04-02 12:21:05 -04:00
* Re - maps 'edit_post' meta cap for a customize_changeset post to be the same as 'customize' maps .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*
* There is essentially a " meta meta " cap in play here , where 'edit_post' meta cap maps to
* the 'customize' meta cap which then maps to 'edit_theme_options' . This is currently
* required in core for `wp_create_post_autosave()` because it will call
* `_wp_translate_postdata()` which in turn will check if a user can 'edit_post' , but the
* the caps for the customize_changeset post type are all mapping to the meta capability .
* This should be able to be removed once #40922 is addressed in core.
*
* @ since 4.9 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
* @ link https :// core . trac . wordpress . org / ticket / 40922
* @ see WP_Customize_Manager :: save_changeset_post ()
* @ see _wp_translate_postdata ()
*
2018-03-25 14:10:32 -04:00
* @ param string [] $caps Array of the user ' s capabilities .
* @ param string $cap Capability name .
* @ param int $user_id The user ID .
* @ param array $args Adds the context to the cap . Typically the object ID .
2020-02-27 15:09:06 -05:00
* @ return array Capabilities .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*/
public function grant_edit_post_capability_for_changeset ( $caps , $cap , $user_id , $args ) {
if ( 'edit_post' === $cap && ! empty ( $args [ 0 ] ) && 'customize_changeset' === get_post_type ( $args [ 0 ] ) ) {
$post_type_obj = get_post_type_object ( 'customize_changeset' );
2017-11-30 18:11:00 -05:00
$caps = map_meta_cap ( $post_type_obj -> cap -> $cap , $user_id );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
return $caps ;
}
2017-10-12 00:01:46 -04:00
/**
* Marks the changeset post as being currently edited by the current user .
*
* @ since 4.9 . 0
*
2020-06-20 08:02:12 -04:00
* @ param int $changeset_post_id Changeset post ID .
* @ param bool $take_over Whether to take over the changeset . Default false .
2017-10-12 00:01:46 -04:00
*/
public function set_changeset_lock ( $changeset_post_id , $take_over = false ) {
if ( $changeset_post_id ) {
$can_override = ! ( bool ) get_post_meta ( $changeset_post_id , '_edit_lock' , true );
if ( $take_over ) {
$can_override = true ;
}
if ( $can_override ) {
$lock = sprintf ( '%s:%s' , time (), get_current_user_id () );
update_post_meta ( $changeset_post_id , '_edit_lock' , $lock );
} else {
$this -> refresh_changeset_lock ( $changeset_post_id );
}
}
}
/**
* Refreshes changeset lock with the current time if current user edited the changeset before .
*
* @ since 4.9 . 0
*
2020-06-20 08:02:12 -04:00
* @ param int $changeset_post_id Changeset post ID .
2017-10-12 00:01:46 -04:00
*/
public function refresh_changeset_lock ( $changeset_post_id ) {
if ( ! $changeset_post_id ) {
return ;
}
2022-04-04 08:03:03 -04:00
2017-10-12 00:01:46 -04:00
$lock = get_post_meta ( $changeset_post_id , '_edit_lock' , true );
$lock = explode ( ':' , $lock );
if ( $lock && ! empty ( $lock [ 1 ] ) ) {
2020-10-08 17:15:13 -04:00
$user_id = ( int ) $lock [ 1 ];
2017-10-12 00:01:46 -04:00
$current_user_id = get_current_user_id ();
if ( $user_id === $current_user_id ) {
$lock = sprintf ( '%s:%s' , time (), $user_id );
update_post_meta ( $changeset_post_id , '_edit_lock' , $lock );
}
}
}
/**
2020-08-10 20:34:08 -04:00
* Filters heartbeat settings for the Customizer .
2017-10-12 00:01:46 -04:00
*
* @ since 4.9 . 0
2022-04-04 08:03:03 -04:00
*
2022-04-04 14:26:06 -04:00
* @ global string $pagenow The filename of the current screen .
2022-04-04 08:03:03 -04:00
*
2017-10-12 00:01:46 -04:00
* @ param array $settings Current settings to filter .
* @ return array Heartbeat settings .
*/
public function add_customize_screen_to_heartbeat_settings ( $settings ) {
global $pagenow ;
2022-04-04 08:03:03 -04:00
2017-10-12 00:01:46 -04:00
if ( 'customize.php' === $pagenow ) {
$settings [ 'screenId' ] = 'customize' ;
}
2022-04-04 08:03:03 -04:00
2017-10-12 00:01:46 -04:00
return $settings ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets lock user data .
2017-10-12 00:01:46 -04:00
*
* @ since 4.9 . 0
*
* @ param int $user_id User ID .
* @ return array | null User data formatted for client .
*/
protected function get_lock_user_data ( $user_id ) {
if ( ! $user_id ) {
return null ;
}
2022-04-04 08:03:03 -04:00
2017-10-12 00:01:46 -04:00
$lock_user = get_userdata ( $user_id );
2022-04-04 08:03:03 -04:00
2017-10-12 00:01:46 -04:00
if ( ! $lock_user ) {
return null ;
}
2022-04-04 08:03:03 -04:00
2017-10-12 00:01:46 -04:00
return array (
2017-11-30 18:11:00 -05:00
'id' => $lock_user -> ID ,
'name' => $lock_user -> display_name ,
2017-10-12 00:01:46 -04:00
'avatar' => get_avatar_url ( $lock_user -> ID , array ( 'size' => 128 ) ),
);
}
/**
2022-04-02 12:21:05 -04:00
* Checks locked changeset with heartbeat API .
2017-10-12 00:01:46 -04:00
*
* @ since 4.9 . 0
*
* @ param array $response The Heartbeat response .
* @ param array $data The $_POST data sent .
* @ param string $screen_id The screen id .
* @ return array The Heartbeat response .
*/
public function check_changeset_lock_with_heartbeat ( $response , $data , $screen_id ) {
2018-01-29 18:05:31 -05:00
if ( isset ( $data [ 'changeset_uuid' ] ) ) {
$changeset_post_id = $this -> find_changeset_post_id ( $data [ 'changeset_uuid' ] );
} else {
$changeset_post_id = $this -> changeset_post_id ();
}
if (
array_key_exists ( 'check_changeset_lock' , $data )
&& 'customize' === $screen_id
&& $changeset_post_id
&& current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> edit_post , $changeset_post_id )
) {
$lock_user_id = wp_check_post_lock ( $changeset_post_id );
2017-10-12 00:01:46 -04:00
if ( $lock_user_id ) {
$response [ 'customize_changeset_lock_user' ] = $this -> get_lock_user_data ( $lock_user_id );
} else {
// Refreshing time will ensure that the user is sitting on customizer and has not closed the customizer tab.
2018-01-29 18:05:31 -05:00
$this -> refresh_changeset_lock ( $changeset_post_id );
2017-10-12 00:01:46 -04:00
}
}
return $response ;
}
/**
* Removes changeset lock when take over request is sent via Ajax .
*
* @ since 4.9 . 0
*/
public function handle_override_changeset_lock_request () {
if ( ! $this -> is_preview () ) {
wp_send_json_error ( 'not_preview' , 400 );
}
if ( ! check_ajax_referer ( 'customize_override_changeset_lock' , 'nonce' , false ) ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'code' => 'invalid_nonce' ,
'message' => __ ( 'Security check failed.' ),
)
);
2017-10-12 00:01:46 -04:00
}
$changeset_post_id = $this -> changeset_post_id ();
if ( empty ( $changeset_post_id ) ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'code' => 'no_changeset_found_to_take_over' ,
'message' => __ ( 'No changeset found to take over' ),
)
);
2017-10-12 00:01:46 -04:00
}
if ( ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> edit_post , $changeset_post_id ) ) {
2017-11-30 18:11:00 -05:00
wp_send_json_error (
array (
'code' => 'cannot_remove_changeset_lock' ,
'message' => __ ( 'Sorry, you are not allowed to take over.' ),
)
);
2017-10-12 00:01:46 -04:00
}
$this -> set_changeset_lock ( $changeset_post_id , true );
wp_send_json_success ( 'changeset_taken_over' );
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
2022-04-02 12:21:05 -04:00
* Determines whether a changeset revision should be made .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
* @ var bool
*/
protected $store_changeset_revision ;
/**
* Filters whether a changeset has changed to create a new revision .
*
* Note that this will not be called while a changeset post remains in auto - draft status .
*
* @ since 4.7 . 0
*
* @ param bool $post_has_changed Whether the post has changed .
2022-07-25 15:30:09 -04:00
* @ param WP_Post $latest_revision The latest revision post object .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ param WP_Post $post The post object .
* @ return bool Whether a revision should be made .
*/
2022-07-25 15:30:09 -04:00
public function _filter_revision_post_has_changed ( $post_has_changed , $latest_revision , $post ) {
unset ( $latest_revision );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( 'customize_changeset' === $post -> post_type ) {
$post_has_changed = $this -> store_changeset_revision ;
}
return $post_has_changed ;
}
/**
2022-04-02 12:21:05 -04:00
* Publishes the values of a changeset .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
2022-04-02 12:21:05 -04:00
* This will publish the values contained in a changeset , even changesets that do not
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* correspond to current manager instance . This is called by
* `_wp_customize_publish_changeset()` when a customize_changeset post is
* transitioned to the `publish` status . As such , this method should not be
* called directly and instead `wp_publish_post()` should be used .
*
* Please note that if the settings in the changeset are for a non - activated
* theme , the theme must first be switched to ( via `switch_theme()` ) before
* invoking this method .
*
* @ since 4.7 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ see _wp_customize_publish_changeset ()
2019-08-03 21:12:56 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ param int $changeset_post_id ID for customize_changeset post . Defaults to the changeset for the current manager instance .
* @ return true | WP_Error True or error info .
*/
public function _publish_changeset_values ( $changeset_post_id ) {
2017-10-12 00:01:46 -04:00
global $wpdb ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$publishing_changeset_data = $this -> get_changeset_post_data ( $changeset_post_id );
if ( is_wp_error ( $publishing_changeset_data ) ) {
return $publishing_changeset_data ;
}
$changeset_post = get_post ( $changeset_post_id );
/*
* Temporarily override the changeset context so that it will be read
* in calls to unsanitized_post_values () and so that it will be available
* on the $wp_customize object passed to hooks during the save logic .
*/
$previous_changeset_post_id = $this -> _changeset_post_id ;
$this -> _changeset_post_id = $changeset_post_id ;
$previous_changeset_uuid = $this -> _changeset_uuid ;
$this -> _changeset_uuid = $changeset_post -> post_name ;
$previous_changeset_data = $this -> _changeset_data ;
$this -> _changeset_data = $publishing_changeset_data ;
2016-11-09 02:03:30 -05:00
// Parse changeset data to identify theme mod settings and user IDs associated with settings to be saved.
2017-11-30 18:11:00 -05:00
$setting_user_ids = array ();
2016-11-09 02:03:30 -05:00
$theme_mod_settings = array ();
2017-11-30 18:11:00 -05:00
$namespace_pattern = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/' ;
$matches = array ();
2016-11-09 02:03:30 -05:00
foreach ( $this -> _changeset_data as $raw_setting_id => $setting_params ) {
2017-11-30 18:11:00 -05:00
$actual_setting_id = null ;
2016-11-09 02:03:30 -05:00
$is_theme_mod_setting = (
isset ( $setting_params [ 'value' ] )
&&
isset ( $setting_params [ 'type' ] )
&&
'theme_mod' === $setting_params [ 'type' ]
&&
preg_match ( $namespace_pattern , $raw_setting_id , $matches )
);
if ( $is_theme_mod_setting ) {
if ( ! isset ( $theme_mod_settings [ $matches [ 'stylesheet' ] ] ) ) {
$theme_mod_settings [ $matches [ 'stylesheet' ] ] = array ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
2016-11-09 02:03:30 -05:00
$theme_mod_settings [ $matches [ 'stylesheet' ] ][ $matches [ 'setting_id' ] ] = $setting_params ;
if ( $this -> get_stylesheet () === $matches [ 'stylesheet' ] ) {
$actual_setting_id = $matches [ 'setting_id' ];
}
} else {
$actual_setting_id = $raw_setting_id ;
}
// Keep track of the user IDs for settings actually for this theme.
if ( $actual_setting_id && isset ( $setting_params [ 'user_id' ] ) ) {
$setting_user_ids [ $actual_setting_id ] = $setting_params [ 'user_id' ];
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
}
2017-11-30 18:11:00 -05:00
$changeset_setting_values = $this -> unsanitized_post_values (
array (
'exclude_post_data' => true ,
'exclude_changeset' => false ,
)
);
$changeset_setting_ids = array_keys ( $changeset_setting_values );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> add_dynamic_settings ( $changeset_setting_ids );
2014-03-06 09:11:15 -05:00
/**
* Fires once the theme has switched in the Customizer , but before settings
* have been saved .
*
* @ since 3.4 . 0
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2014-03-06 09:11:15 -05:00
*/
2012-04-30 13:20:32 -04:00
do_action ( 'customize_save' , $this );
2012-02-24 23:12:43 -05:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/*
* Ensure that all settings will allow themselves to be saved . Note that
* this is safe because the setting would have checked the capability
* when the setting value was written into the changeset . So this is why
* an additional capability check is not required here .
*/
$original_setting_capabilities = array ();
foreach ( $changeset_setting_ids as $setting_id ) {
$setting = $this -> get_setting ( $setting_id );
2016-11-09 02:03:30 -05:00
if ( $setting && ! isset ( $setting_user_ids [ $setting_id ] ) ) {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$original_setting_capabilities [ $setting -> id ] = $setting -> capability ;
2017-11-30 18:11:00 -05:00
$setting -> capability = 'exist' ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
}
2016-11-09 02:03:30 -05:00
$original_user_id = get_current_user_id ();
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
foreach ( $changeset_setting_ids as $setting_id ) {
$setting = $this -> get_setting ( $setting_id );
if ( $setting ) {
2016-11-09 02:03:30 -05:00
/*
* Set the current user to match the user who saved the value into
* the changeset so that any filters that apply during the save
* process will respect the original user ' s capabilities . This
* will ensure , for example , that KSES won ' t strip unsafe HTML
* when a scheduled changeset publishes via WP Cron .
*/
if ( isset ( $setting_user_ids [ $setting_id ] ) ) {
wp_set_current_user ( $setting_user_ids [ $setting_id ] );
} else {
wp_set_current_user ( $original_user_id );
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$setting -> save ();
}
}
2016-11-09 02:03:30 -05:00
wp_set_current_user ( $original_user_id );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Update the stashed theme mod settings, removing the active theme's stashed settings, if activated.
if ( did_action ( 'switch_theme' ) ) {
2016-11-09 02:03:30 -05:00
$other_theme_mod_settings = $theme_mod_settings ;
unset ( $other_theme_mod_settings [ $this -> get_stylesheet () ] );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$this -> update_stashed_theme_mod_settings ( $other_theme_mod_settings );
2012-02-24 23:12:43 -05:00
}
2014-03-06 09:11:15 -05:00
/**
* Fires after Customize settings have been saved .
*
* @ since 3.6 . 0
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2014-03-06 09:11:15 -05:00
*/
2013-05-24 06:33:30 -04:00
do_action ( 'customize_save_after' , $this );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Restore original capabilities.
foreach ( $original_setting_capabilities as $setting_id => $capability ) {
$setting = $this -> get_setting ( $setting_id );
if ( $setting ) {
$setting -> capability = $capability ;
}
}
2016-06-14 15:17:28 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Restore original changeset data.
$this -> _changeset_data = $previous_changeset_data ;
$this -> _changeset_post_id = $previous_changeset_post_id ;
$this -> _changeset_uuid = $previous_changeset_uuid ;
2017-10-12 00:01:46 -04:00
/*
* Convert all autosave revisions into their own auto - drafts so that users can be prompted to
* restore them when a changeset is published , but they had been locked out from including
* their changes in the changeset .
*/
$revisions = wp_get_post_revisions ( $changeset_post_id , array ( 'check_enabled' => false ) );
foreach ( $revisions as $revision ) {
Code Modernization: Replace usage of `strpos()` with `str_contains()`.
`str_contains()` was introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) contains the given substring (needle).
WordPress core includes a polyfill for `str_contains()` on PHP < 8.0 as of WordPress 5.9.
This commit replaces `false !== strpos( ... )` with `str_contains()` in core files, making the code more readable and consistent, as well as better aligned with modern development practices.
Follow-up to [52039], [52040], [52326], [55703], [55710], [55987].
Props Soean, spacedmonkey, costdev, dingo_d, azaozz, mikeschroder, flixos90, peterwilsoncc, SergeyBiryukov.
Fixes #58206.
Built from https://develop.svn.wordpress.org/trunk@55988
git-svn-id: http://core.svn.wordpress.org/trunk@55500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-06-22 10:36:26 -04:00
if ( str_contains ( $revision -> post_name , " { $changeset_post_id } -autosave " ) ) {
2017-10-12 00:01:46 -04:00
$wpdb -> update (
$wpdb -> posts ,
array (
'post_status' => 'auto-draft' ,
2017-11-30 18:11:00 -05:00
'post_type' => 'customize_changeset' ,
'post_name' => wp_generate_uuid4 (),
2017-10-12 00:01:46 -04:00
'post_parent' => 0 ,
),
array (
'ID' => $revision -> ID ,
)
);
clean_post_cache ( $revision -> ID );
}
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
return true ;
}
/**
2022-04-02 12:21:05 -04:00
* Updates stashed theme mod settings .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ param array $inactive_theme_mod_settings Mapping of stylesheet to arrays of theme mod settings .
* @ return array | false Returns array of updated stashed theme mods or false if the update failed or there were no changes .
*/
protected function update_stashed_theme_mod_settings ( $inactive_theme_mod_settings ) {
$stashed_theme_mod_settings = get_option ( 'customize_stashed_theme_mods' );
if ( empty ( $stashed_theme_mod_settings ) ) {
$stashed_theme_mod_settings = array ();
}
2017-09-09 09:53:42 -04:00
// Delete any stashed theme mods for the active theme since they would have been loaded and saved upon activation.
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
unset ( $stashed_theme_mod_settings [ $this -> get_stylesheet () ] );
// Merge inactive theme mods with the stashed theme mod settings.
foreach ( $inactive_theme_mod_settings as $stylesheet => $theme_mod_settings ) {
if ( ! isset ( $stashed_theme_mod_settings [ $stylesheet ] ) ) {
$stashed_theme_mod_settings [ $stylesheet ] = array ();
}
$stashed_theme_mod_settings [ $stylesheet ] = array_merge (
$stashed_theme_mod_settings [ $stylesheet ],
$theme_mod_settings
);
}
$autoload = false ;
2017-11-30 18:11:00 -05:00
$result = update_option ( 'customize_stashed_theme_mods' , $stashed_theme_mod_settings , $autoload );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( ! $result ) {
return false ;
}
return $stashed_theme_mod_settings ;
2012-02-24 23:12:43 -05:00
}
2015-04-06 11:10:27 -04:00
/**
2022-04-02 12:21:05 -04:00
* Refreshes nonces for the current preview .
2015-04-06 11:10:27 -04:00
*
* @ since 4.2 . 0
*/
public function refresh_nonces () {
if ( ! $this -> is_preview () ) {
wp_send_json_error ( 'not_preview' );
}
2016-01-27 12:55:26 -05:00
wp_send_json_success ( $this -> get_nonces () );
2015-04-06 11:10:27 -04:00
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
/**
2022-04-02 12:21:05 -04:00
* Deletes a given auto - draft changeset or the autosave revision for a given changeset or delete changeset lock .
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
*
* @ since 4.9 . 0
*/
2017-10-12 00:01:46 -04:00
public function handle_dismiss_autosave_or_lock_request () {
2018-01-29 19:21:30 -05:00
// Calls to dismiss_user_auto_draft_changesets() and wp_get_post_autosave() require non-zero get_current_user_id().
if ( ! is_user_logged_in () ) {
wp_send_json_error ( 'unauthenticated' , 401 );
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( ! $this -> is_preview () ) {
wp_send_json_error ( 'not_preview' , 400 );
}
2017-10-12 00:01:46 -04:00
if ( ! check_ajax_referer ( 'customize_dismiss_autosave_or_lock' , 'nonce' , false ) ) {
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
wp_send_json_error ( 'invalid_nonce' , 403 );
}
$changeset_post_id = $this -> changeset_post_id ();
2017-11-30 18:11:00 -05:00
$dismiss_lock = ! empty ( $_POST [ 'dismiss_lock' ] );
$dismiss_autosave = ! empty ( $_POST [ 'dismiss_autosave' ] );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
2017-10-12 00:01:46 -04:00
if ( $dismiss_lock ) {
if ( empty ( $changeset_post_id ) && ! $dismiss_autosave ) {
wp_send_json_error ( 'no_changeset_to_dismiss_lock' , 404 );
}
if ( ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> edit_post , $changeset_post_id ) && ! $dismiss_autosave ) {
wp_send_json_error ( 'cannot_remove_changeset_lock' , 403 );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
2017-10-12 00:01:46 -04:00
delete_post_meta ( $changeset_post_id , '_edit_lock' );
if ( ! $dismiss_autosave ) {
wp_send_json_success ( 'changeset_lock_dismissed' );
}
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
2017-10-12 00:01:46 -04:00
if ( $dismiss_autosave ) {
if ( empty ( $changeset_post_id ) || 'auto-draft' === get_post_status ( $changeset_post_id ) ) {
$dismissed = $this -> dismiss_user_auto_draft_changesets ();
if ( $dismissed > 0 ) {
wp_send_json_success ( 'auto_draft_dismissed' );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
} else {
2017-10-12 00:01:46 -04:00
wp_send_json_error ( 'no_auto_draft_to_delete' , 404 );
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
} else {
2017-10-12 00:01:46 -04:00
$revision = wp_get_post_autosave ( $changeset_post_id , get_current_user_id () );
if ( $revision ) {
if ( ! current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> delete_post , $changeset_post_id ) ) {
wp_send_json_error ( 'cannot_delete_autosave_revision' , 403 );
}
if ( ! wp_delete_post ( $revision -> ID , true ) ) {
wp_send_json_error ( 'autosave_revision_deletion_failure' , 500 );
} else {
wp_send_json_success ( 'autosave_revision_deleted' );
}
} else {
wp_send_json_error ( 'no_autosave_revision_to_delete' , 404 );
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
}
}
2017-10-12 00:01:46 -04:00
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
wp_send_json_error ( 'unknown_error' , 500 );
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Adds a customize setting .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
2015-12-06 13:10:25 -05:00
* @ since 4.5 . 0 Return added WP_Customize_Setting instance .
2012-02-24 23:12:43 -05:00
*
2020-02-27 15:09:06 -05:00
* @ see WP_Customize_Setting :: __construct ()
2019-11-09 20:43:02 -05:00
* @ link https :// developer . wordpress . org / themes / customize - api
*
2015-12-06 13:10:25 -05:00
* @ param WP_Customize_Setting | string $id Customize Setting object , or ID .
2020-02-27 15:09:06 -05:00
* @ param array $args Optional . Array of properties for the new Setting object .
* See WP_Customize_Setting :: __construct () for information
* on accepted arguments . Default empty array .
* @ return WP_Customize_Setting The instance of the setting that was added .
2012-02-24 23:12:43 -05:00
*/
public function add_setting ( $id , $args = array () ) {
2015-01-15 20:06:24 -05:00
if ( $id instanceof WP_Customize_Setting ) {
2012-03-28 00:14:09 -04:00
$setting = $id ;
2015-01-15 20:06:24 -05:00
} else {
2015-12-06 18:22:25 -05:00
$class = 'WP_Customize_Setting' ;
/** This filter is documented in wp-includes/class-wp-customize-manager.php */
$args = apply_filters ( 'customize_dynamic_setting_args' , $args , $id );
/** This filter is documented in wp-includes/class-wp-customize-manager.php */
$class = apply_filters ( 'customize_dynamic_setting_class' , $class , $id , $args );
$setting = new $class ( $this , $id , $args );
2015-01-15 20:06:24 -05:00
}
2015-12-06 13:10:25 -05:00
2012-02-24 23:12:43 -05:00
$this -> settings [ $setting -> id ] = $setting ;
2015-12-06 13:10:25 -05:00
return $setting ;
2012-02-24 23:12:43 -05:00
}
2015-02-08 18:11:25 -05:00
/**
2022-04-02 12:21:05 -04:00
* Registers any dynamically - created settings , such as those from $_POST [ 'customized' ]
2015-04-05 11:07:27 -04:00
* that have no corresponding setting created .
2015-02-08 18:11:25 -05:00
*
* This is a mechanism to " wake up " settings that have been dynamically created
2016-02-25 07:53:27 -05:00
* on the front end and have been sent to WordPress in `$_POST['customized']` . When WP
2015-02-08 18:11:25 -05:00
* loads , the dynamically - created settings then will get created and previewed
* even though they are not directly created statically with code .
*
* @ since 4.2 . 0
*
2015-05-21 18:05:24 -04:00
* @ param array $setting_ids The setting IDs to add .
2015-11-04 19:43:24 -05:00
* @ return array The WP_Customize_Setting objects added .
2015-02-08 18:11:25 -05:00
*/
public function add_dynamic_settings ( $setting_ids ) {
$new_settings = array ();
foreach ( $setting_ids as $setting_id ) {
2020-01-28 19:45:18 -05:00
// Skip settings already created.
2015-02-08 18:11:25 -05:00
if ( $this -> get_setting ( $setting_id ) ) {
continue ;
}
2017-11-30 18:11:00 -05:00
$setting_args = false ;
2015-02-08 18:11:25 -05:00
$setting_class = 'WP_Customize_Setting' ;
/**
2016-05-22 14:10:29 -04:00
* Filters a dynamic setting ' s constructor args .
2015-02-08 18:11:25 -05:00
*
* For a dynamic setting to be registered , this filter must be employed
* to override the default false value with an array of args to pass to
* the WP_Customize_Setting constructor .
*
* @ since 4.2 . 0
*
2015-04-05 11:07:27 -04:00
* @ param false | array $setting_args The arguments to the WP_Customize_Setting constructor .
* @ param string $setting_id ID for dynamic setting , usually coming from `$_POST['customized']` .
2015-02-08 18:11:25 -05:00
*/
$setting_args = apply_filters ( 'customize_dynamic_setting_args' , $setting_args , $setting_id );
if ( false === $setting_args ) {
continue ;
}
/**
* Allow non - statically created settings to be constructed with custom WP_Customize_Setting subclass .
*
* @ since 4.2 . 0
*
2015-04-05 11:07:27 -04:00
* @ param string $setting_class WP_Customize_Setting or a subclass .
* @ param string $setting_id ID for dynamic setting , usually coming from `$_POST['customized']` .
2015-06-12 18:54:25 -04:00
* @ param array $setting_args WP_Customize_Setting or a subclass .
2015-02-08 18:11:25 -05:00
*/
$setting_class = apply_filters ( 'customize_dynamic_setting_class' , $setting_class , $setting_id , $setting_args );
$setting = new $setting_class ( $this , $setting_id , $setting_args );
2015-04-05 11:07:27 -04:00
2015-02-08 18:11:25 -05:00
$this -> add_setting ( $setting );
$new_settings [] = $setting ;
}
return $new_settings ;
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Retrieves a customize setting .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
2014-03-04 15:21:14 -05:00
* @ param string $id Customize Setting ID .
2015-05-24 01:40:25 -04:00
* @ return WP_Customize_Setting | void The setting , if set .
2012-02-24 23:12:43 -05:00
*/
public function get_setting ( $id ) {
2015-02-08 18:11:25 -05:00
if ( isset ( $this -> settings [ $id ] ) ) {
2012-02-24 23:12:43 -05:00
return $this -> settings [ $id ];
2015-02-08 18:11:25 -05:00
}
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Removes a customize setting .
2012-02-24 23:12:43 -05:00
*
2020-02-25 12:50:05 -05:00
* Note that removing the setting doesn ' t destroy the WP_Customize_Setting instance or remove its filters .
*
2012-02-24 23:12:43 -05:00
* @ since 3.4 . 0
*
2014-03-04 15:21:14 -05:00
* @ param string $id Customize Setting ID .
2012-02-24 23:12:43 -05:00
*/
public function remove_setting ( $id ) {
unset ( $this -> settings [ $id ] );
}
2014-06-26 16:17:15 -04:00
/**
2022-04-02 12:21:05 -04:00
* Adds a customize panel .
2014-06-26 16:17:15 -04:00
*
* @ since 4.0 . 0
2015-12-06 13:10:25 -05:00
* @ since 4.5 . 0 Return added WP_Customize_Panel instance .
2014-06-26 16:17:15 -04:00
*
2020-02-27 15:36:07 -05:00
* @ see WP_Customize_Panel :: __construct ()
*
* @ param WP_Customize_Panel | string $id Customize Panel object , or ID .
* @ param array $args Optional . Array of properties for the new Panel object .
* See WP_Customize_Panel :: __construct () for information
* on accepted arguments . Default empty array .
2020-02-27 15:09:06 -05:00
* @ return WP_Customize_Panel The instance of the panel that was added .
2014-06-26 16:17:15 -04:00
*/
public function add_panel ( $id , $args = array () ) {
2015-01-15 20:06:24 -05:00
if ( $id instanceof WP_Customize_Panel ) {
2014-06-26 16:17:15 -04:00
$panel = $id ;
2015-01-15 20:06:24 -05:00
} else {
2014-06-26 16:17:15 -04:00
$panel = new WP_Customize_Panel ( $this , $id , $args );
}
$this -> panels [ $panel -> id ] = $panel ;
2015-12-06 13:10:25 -05:00
return $panel ;
2014-06-26 16:17:15 -04:00
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves a customize panel .
2014-06-26 16:17:15 -04:00
*
* @ since 4.0 . 0
*
2014-07-13 20:36:15 -04:00
* @ param string $id Panel ID to get .
2015-05-24 01:40:25 -04:00
* @ return WP_Customize_Panel | void Requested panel instance , if set .
2014-06-26 16:17:15 -04:00
*/
public function get_panel ( $id ) {
if ( isset ( $this -> panels [ $id ] ) ) {
return $this -> panels [ $id ];
}
}
/**
2022-04-02 12:21:05 -04:00
* Removes a customize panel .
2014-06-26 16:17:15 -04:00
*
2020-02-25 12:50:05 -05:00
* Note that removing the panel doesn ' t destroy the WP_Customize_Panel instance or remove its filters .
*
2014-06-26 16:17:15 -04:00
* @ since 4.0 . 0
*
2014-07-13 20:36:15 -04:00
* @ param string $id Panel ID to remove .
2014-06-26 16:17:15 -04:00
*/
public function remove_panel ( $id ) {
2016-01-11 15:28:28 -05:00
// Removing core components this way is _doing_it_wrong().
if ( in_array ( $id , $this -> components , true ) ) {
2021-06-15 11:22:58 -04:00
_doing_it_wrong (
__METHOD__ ,
2020-07-25 12:01:07 -04:00
sprintf (
2021-06-15 11:22:58 -04:00
/* translators: 1: Panel ID, 2: Link to 'customize_loaded_components' filter reference. */
__ ( 'Removing %1$s manually will cause PHP warnings. Use the %2$s filter instead.' ),
$id ,
sprintf (
'<a href="%1$s">%2$s</a>' ,
esc_url ( 'https://developer.wordpress.org/reference/hooks/customize_loaded_components/' ),
'<code>customize_loaded_components</code>'
)
),
'4.5.0'
2016-01-07 01:06:28 -05:00
);
}
2014-06-26 16:17:15 -04:00
unset ( $this -> panels [ $id ] );
}
2015-05-29 20:03:30 -04:00
/**
2022-04-02 12:21:05 -04:00
* Registers a customize panel type .
2015-05-29 20:03:30 -04:00
*
* Registered types are eligible to be rendered via JS and created dynamically .
*
* @ since 4.3 . 0
*
2015-07-13 16:32:24 -04:00
* @ see WP_Customize_Panel
*
* @ param string $panel Name of a custom panel which is a subclass of WP_Customize_Panel .
2015-05-29 20:03:30 -04:00
*/
public function register_panel_type ( $panel ) {
$this -> registered_panel_types [] = $panel ;
}
/**
2022-04-02 12:21:05 -04:00
* Renders JS templates for all registered panel types .
2015-05-29 20:03:30 -04:00
*
* @ since 4.3 . 0
*/
public function render_panel_templates () {
foreach ( $this -> registered_panel_types as $panel_type ) {
$panel = new $panel_type ( $this , 'temp' , array () );
$panel -> print_template ();
}
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Adds a customize section .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
2015-12-06 13:10:25 -05:00
* @ since 4.5 . 0 Return added WP_Customize_Section instance .
2012-02-24 23:12:43 -05:00
*
2020-02-27 15:29:06 -05:00
* @ see WP_Customize_Section :: __construct ()
*
2020-02-27 15:36:07 -05:00
* @ param WP_Customize_Section | string $id Customize Section object , or ID .
2020-02-27 15:29:06 -05:00
* @ param array $args Optional . Array of properties for the new Section object .
* See WP_Customize_Section :: __construct () for information
* on accepted arguments . Default empty array .
2020-02-27 15:09:06 -05:00
* @ return WP_Customize_Section The instance of the section that was added .
2012-02-24 23:12:43 -05:00
*/
public function add_section ( $id , $args = array () ) {
2015-01-15 20:06:24 -05:00
if ( $id instanceof WP_Customize_Section ) {
2012-03-28 00:14:09 -04:00
$section = $id ;
2015-01-15 20:06:24 -05:00
} else {
2012-03-28 00:14:09 -04:00
$section = new WP_Customize_Section ( $this , $id , $args );
2015-01-15 20:06:24 -05:00
}
2015-12-06 13:10:25 -05:00
2012-02-24 23:12:43 -05:00
$this -> sections [ $section -> id ] = $section ;
2015-12-06 13:10:25 -05:00
return $section ;
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves a customize section .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*
2014-03-04 15:21:14 -05:00
* @ param string $id Section ID .
2015-05-24 01:40:25 -04:00
* @ return WP_Customize_Section | void The section , if set .
2012-02-24 23:12:43 -05:00
*/
public function get_section ( $id ) {
2017-11-30 18:11:00 -05:00
if ( isset ( $this -> sections [ $id ] ) ) {
2012-02-24 23:12:43 -05:00
return $this -> sections [ $id ];
2017-11-30 18:11:00 -05:00
}
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Removes a customize section .
2012-02-24 23:12:43 -05:00
*
2020-02-25 12:50:05 -05:00
* Note that removing the section doesn ' t destroy the WP_Customize_Section instance or remove its filters .
*
2012-02-24 23:12:43 -05:00
* @ since 3.4 . 0
*
2014-03-04 15:21:14 -05:00
* @ param string $id Section ID .
2012-02-24 23:12:43 -05:00
*/
public function remove_section ( $id ) {
unset ( $this -> sections [ $id ] );
}
2015-05-29 20:03:30 -04:00
/**
2022-04-02 12:21:05 -04:00
* Registers a customize section type .
2015-05-29 20:03:30 -04:00
*
* Registered types are eligible to be rendered via JS and created dynamically .
*
* @ since 4.3 . 0
*
2015-07-13 16:32:24 -04:00
* @ see WP_Customize_Section
*
* @ param string $section Name of a custom section which is a subclass of WP_Customize_Section .
2015-05-29 20:03:30 -04:00
*/
public function register_section_type ( $section ) {
$this -> registered_section_types [] = $section ;
}
/**
2022-04-02 12:21:05 -04:00
* Renders JS templates for all registered section types .
2015-05-29 20:03:30 -04:00
*
* @ since 4.3 . 0
*/
public function render_section_templates () {
foreach ( $this -> registered_section_types as $section_type ) {
$section = new $section_type ( $this , 'temp' , array () );
$section -> print_template ();
}
}
2012-03-28 00:14:09 -04:00
/**
2022-04-02 12:21:05 -04:00
* Adds a customize control .
2012-03-28 00:14:09 -04:00
*
* @ since 3.4 . 0
2015-12-06 13:10:25 -05:00
* @ since 4.5 . 0 Return added WP_Customize_Control instance .
2012-03-28 00:14:09 -04:00
*
2020-02-26 08:30:08 -05:00
* @ see WP_Customize_Control :: __construct ()
*
2014-03-04 15:21:14 -05:00
* @ param WP_Customize_Control | string $id Customize Control object , or ID .
2020-02-25 11:41:07 -05:00
* @ param array $args Optional . Array of properties for the new Control object .
* See WP_Customize_Control :: __construct () for information
* on accepted arguments . Default empty array .
2020-02-27 15:09:06 -05:00
* @ return WP_Customize_Control The instance of the control that was added .
2012-03-28 00:14:09 -04:00
*/
public function add_control ( $id , $args = array () ) {
2015-01-15 20:06:24 -05:00
if ( $id instanceof WP_Customize_Control ) {
2012-03-28 00:14:09 -04:00
$control = $id ;
2015-01-15 20:06:24 -05:00
} else {
2012-03-28 00:14:09 -04:00
$control = new WP_Customize_Control ( $this , $id , $args );
2015-01-15 20:06:24 -05:00
}
2015-12-06 13:10:25 -05:00
2012-03-28 00:14:09 -04:00
$this -> controls [ $control -> id ] = $control ;
2015-12-06 13:10:25 -05:00
return $control ;
2012-03-28 00:14:09 -04:00
}
/**
2022-04-02 12:21:05 -04:00
* Retrieves a customize control .
2012-03-28 00:14:09 -04:00
*
* @ since 3.4 . 0
*
2014-03-04 15:21:14 -05:00
* @ param string $id ID of the control .
2015-05-24 01:40:25 -04:00
* @ return WP_Customize_Control | void The control object , if set .
2012-03-28 00:14:09 -04:00
*/
public function get_control ( $id ) {
2017-11-30 18:11:00 -05:00
if ( isset ( $this -> controls [ $id ] ) ) {
2012-03-28 00:14:09 -04:00
return $this -> controls [ $id ];
2017-11-30 18:11:00 -05:00
}
2012-03-28 00:14:09 -04:00
}
/**
2022-04-02 12:21:05 -04:00
* Removes a customize control .
2012-03-28 00:14:09 -04:00
*
2020-02-25 12:50:05 -05:00
* Note that removing the control doesn ' t destroy the WP_Customize_Control instance or remove its filters .
*
2012-03-28 00:14:09 -04:00
* @ since 3.4 . 0
*
2014-03-04 15:21:14 -05:00
* @ param string $id ID of the control .
2012-03-28 00:14:09 -04:00
*/
public function remove_control ( $id ) {
unset ( $this -> controls [ $id ] );
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Registers a customize control type .
2014-10-24 12:32:18 -04:00
*
2014-11-28 05:52:22 -05:00
* Registered types are eligible to be rendered via JS and created dynamically .
2014-10-24 12:32:18 -04:00
*
* @ since 4.1 . 0
*
2014-11-28 05:52:22 -05:00
* @ param string $control Name of a custom control which is a subclass of
2016-05-02 00:00:28 -04:00
* WP_Customize_Control .
2014-10-24 12:32:18 -04:00
*/
public function register_control_type ( $control ) {
$this -> registered_control_types [] = $control ;
}
/**
2022-04-02 12:21:05 -04:00
* Renders JS templates for all registered control types .
2014-10-24 12:32:18 -04:00
*
* @ since 4.1 . 0
*/
public function render_control_templates () {
2018-01-22 01:28:31 -05:00
if ( $this -> branching () ) {
$l10n = array (
/* translators: %s: User who is customizing the changeset in customizer. */
2018-08-16 21:51:36 -04:00
'locked' => __ ( '%s is already customizing this changeset. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ),
2018-01-22 01:28:31 -05:00
/* translators: %s: User who is customizing the changeset in customizer. */
'locked_allow_override' => __ ( '%s is already customizing this changeset. Do you want to take over?' ),
);
} else {
$l10n = array (
/* translators: %s: User who is customizing the changeset in customizer. */
2018-08-16 21:51:36 -04:00
'locked' => __ ( '%s is already customizing this site. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ),
2018-01-22 01:28:31 -05:00
/* translators: %s: User who is customizing the changeset in customizer. */
'locked_allow_override' => __ ( '%s is already customizing this site. Do you want to take over?' ),
);
}
2014-11-03 16:35:23 -05:00
foreach ( $this -> registered_control_types as $control_type ) {
2017-11-30 18:11:00 -05:00
$control = new $control_type (
2018-08-16 21:51:36 -04:00
$this ,
'temp' ,
array (
2017-11-30 18:11:00 -05:00
'settings' => array (),
)
);
2014-10-24 12:32:18 -04:00
$control -> print_template ();
}
Customize: Add global notifications area.
* Displays an error notification in the global area when a save attempt is rejected due to invalid settings. An error notification is also displayed when saving fails due to a network error or server error.
* Introduces `wp.customize.Notifications` subclass of `wp.customize.Values` to contain instances of `wp.customize.Notification` and manage their rendering into a container.
* Exposes the global notification area as `wp.customize.notifications` collection instance.
* Updates the `notifications` object on `Control` to use `Notifications` rather than `Values` and to re-use the rendering logic from the former. The old `Control#renderNotifications` method is deprecated.
* Allows notifications to be dismissed by instantiating them with a `dismissible` property.
* Allows `wp.customize.Notification` to be extended with custom templates and `render` functions.
* Triggers a `removed` event on `wp.customize.Values` instances _after_ a value has been removed from the collection.
Props delawski, westonruter, karmatosed, celloexpressions, Fab1en, melchoyce, Kelderic, afercia, adamsilverstein.
See #34893, #39896.
Fixes #35210, #31582, #37727, #37269.
Built from https://develop.svn.wordpress.org/trunk@41374
git-svn-id: http://core.svn.wordpress.org/trunk@41207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-12 03:03:46 -04:00
?>
2017-10-04 22:56:47 -04:00
< script type = " text/html " id = " tmpl-customize-control-default-content " >
< #
var inputId = _ . uniqueId ( 'customize-control-default-input-' );
var descriptionId = _ . uniqueId ( 'customize-control-default-description-' );
var describedByAttr = data . description ? ' aria-describedby="' + descriptionId + '" ' : '' ;
#>
< # switch ( data.type ) {
case 'checkbox' : #>
< span class = " customize-inside-control-row " >
< input
id = " { { inputId }} "
{{{ describedByAttr }}}
type = " checkbox "
value = " { { data.value }} "
data - customize - setting - key - link = " default "
>
< label for = " { { inputId }} " >
{{ data . label }}
</ label >
< # if ( data.description ) { #>
< span id = " { { descriptionId }} " class = " description customize-control-description " > {{{ data . description }}} </ span >
< # } #>
</ span >
< #
break ;
case 'radio' :
if ( ! data . choices ) {
return ;
}
#>
< # if ( data.label ) { #>
< label for = " { { inputId }} " class = " customize-control-title " >
{{ data . label }}
</ label >
< # } #>
< # if ( data.description ) { #>
< span id = " { { descriptionId }} " class = " description customize-control-description " > {{{ data . description }}} </ span >
< # } #>
< # _.each( data.choices, function( val, key ) { #>
< span class = " customize-inside-control-row " >
< #
var value , text ;
if ( _ . isObject ( val ) ) {
value = val . value ;
text = val . text ;
} else {
value = key ;
text = val ;
}
#>
< input
id = " { { inputId + '-' + value }} "
type = " radio "
value = " { { value }} "
name = " { { inputId }} "
data - customize - setting - key - link = " default "
{{{ describedByAttr }}}
>
< label for = " { { inputId + '-' + value }} " > {{ text }} </ label >
</ span >
< # } ); #>
< #
break ;
default :
#>
< # if ( data.label ) { #>
< label for = " { { inputId }} " class = " customize-control-title " >
{{ data . label }}
</ label >
< # } #>
< # if ( data.description ) { #>
< span id = " { { descriptionId }} " class = " description customize-control-description " > {{{ data . description }}} </ span >
< # } #>
< #
var inputAttrs = {
id : inputId ,
'data-customize-setting-key-link' : 'default'
};
if ( 'textarea' === data . type ) {
inputAttrs . rows = '5' ;
} else if ( 'button' === data . type ) {
inputAttrs [ 'class' ] = 'button button-secondary' ;
inputAttrs . type = 'button' ;
} else {
inputAttrs . type = data . type ;
}
if ( data . description ) {
inputAttrs [ 'aria-describedby' ] = descriptionId ;
}
2017-10-18 23:25:47 -04:00
_ . extend ( inputAttrs , data . input_attrs );
2017-10-04 22:56:47 -04:00
#>
< # if ( 'button' === data.type ) { #>
< button
< # _.each( _.extend( inputAttrs ), function( value, key ) { #>
{{{ key }}} = " { { value }} "
< # } ); #>
> {{ inputAttrs . value }} </ button >
< # } else if ( 'textarea' === data.type ) { #>
< textarea
< # _.each( _.extend( inputAttrs ), function( value, key ) { #>
{{{ key }}} = " { { value }} "
< # }); #>
> {{ inputAttrs . value }} </ textarea >
< # } else if ( 'select' === data.type ) { #>
2017-10-19 23:30:46 -04:00
< # delete inputAttrs.type; #>
2017-10-04 22:56:47 -04:00
< select
< # _.each( _.extend( inputAttrs ), function( value, key ) { #>
{{{ key }}} = " { { value }} "
< # }); #>
>
< # _.each( data.choices, function( val, key ) { #>
< #
var value , text ;
if ( _ . isObject ( val ) ) {
value = val . value ;
text = val . text ;
} else {
value = key ;
text = val ;
}
#>
< option value = " { { value }} " > {{ text }} </ option >
< # } ); #>
</ select >
< # } else { #>
< input
< # _.each( _.extend( inputAttrs ), function( value, key ) { #>
{{{ key }}} = " { { value }} "
< # }); #>
>
< # } #>
< # } #>
</ script >
Customize: Add global notifications area.
* Displays an error notification in the global area when a save attempt is rejected due to invalid settings. An error notification is also displayed when saving fails due to a network error or server error.
* Introduces `wp.customize.Notifications` subclass of `wp.customize.Values` to contain instances of `wp.customize.Notification` and manage their rendering into a container.
* Exposes the global notification area as `wp.customize.notifications` collection instance.
* Updates the `notifications` object on `Control` to use `Notifications` rather than `Values` and to re-use the rendering logic from the former. The old `Control#renderNotifications` method is deprecated.
* Allows notifications to be dismissed by instantiating them with a `dismissible` property.
* Allows `wp.customize.Notification` to be extended with custom templates and `render` functions.
* Triggers a `removed` event on `wp.customize.Values` instances _after_ a value has been removed from the collection.
Props delawski, westonruter, karmatosed, celloexpressions, Fab1en, melchoyce, Kelderic, afercia, adamsilverstein.
See #34893, #39896.
Fixes #35210, #31582, #37727, #37269.
Built from https://develop.svn.wordpress.org/trunk@41374
git-svn-id: http://core.svn.wordpress.org/trunk@41207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-12 03:03:46 -04:00
< script type = " text/html " id = " tmpl-customize-notification " >
2017-10-04 02:48:46 -04:00
< li class = " notice notice- { { data.type || 'info' }} { { data.alt ? 'notice-alt' : '' }} { { data.dismissible ? 'is-dismissible' : '' }} { { data.containerClasses || '' }} " data - code = " { { data.code }} " data - type = " { { data.type }} " >
2017-10-01 23:37:46 -04:00
< div class = " notification-message " > {{{ data . message || data . code }}} </ div >
Customize: Add global notifications area.
* Displays an error notification in the global area when a save attempt is rejected due to invalid settings. An error notification is also displayed when saving fails due to a network error or server error.
* Introduces `wp.customize.Notifications` subclass of `wp.customize.Values` to contain instances of `wp.customize.Notification` and manage their rendering into a container.
* Exposes the global notification area as `wp.customize.notifications` collection instance.
* Updates the `notifications` object on `Control` to use `Notifications` rather than `Values` and to re-use the rendering logic from the former. The old `Control#renderNotifications` method is deprecated.
* Allows notifications to be dismissed by instantiating them with a `dismissible` property.
* Allows `wp.customize.Notification` to be extended with custom templates and `render` functions.
* Triggers a `removed` event on `wp.customize.Values` instances _after_ a value has been removed from the collection.
Props delawski, westonruter, karmatosed, celloexpressions, Fab1en, melchoyce, Kelderic, afercia, adamsilverstein.
See #34893, #39896.
Fixes #35210, #31582, #37727, #37269.
Built from https://develop.svn.wordpress.org/trunk@41374
git-svn-id: http://core.svn.wordpress.org/trunk@41207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-12 03:03:46 -04:00
< # if ( data.dismissible ) { #>
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
< button type = " button " class = " notice-dismiss " >< span class = " screen-reader-text " >
< ? php
/* translators: Hidden accessibility text. */
_e ( 'Dismiss' );
?>
</ span ></ button >
Customize: Add global notifications area.
* Displays an error notification in the global area when a save attempt is rejected due to invalid settings. An error notification is also displayed when saving fails due to a network error or server error.
* Introduces `wp.customize.Notifications` subclass of `wp.customize.Values` to contain instances of `wp.customize.Notification` and manage their rendering into a container.
* Exposes the global notification area as `wp.customize.notifications` collection instance.
* Updates the `notifications` object on `Control` to use `Notifications` rather than `Values` and to re-use the rendering logic from the former. The old `Control#renderNotifications` method is deprecated.
* Allows notifications to be dismissed by instantiating them with a `dismissible` property.
* Allows `wp.customize.Notification` to be extended with custom templates and `render` functions.
* Triggers a `removed` event on `wp.customize.Values` instances _after_ a value has been removed from the collection.
Props delawski, westonruter, karmatosed, celloexpressions, Fab1en, melchoyce, Kelderic, afercia, adamsilverstein.
See #34893, #39896.
Fixes #35210, #31582, #37727, #37269.
Built from https://develop.svn.wordpress.org/trunk@41374
git-svn-id: http://core.svn.wordpress.org/trunk@41207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-12 03:03:46 -04:00
< # } #>
</ li >
</ script >
2017-10-12 00:01:46 -04:00
< script type = " text/html " id = " tmpl-customize-changeset-locked-notification " >
< li class = " notice notice- { { data.type || 'info' }} { { data.containerClasses || '' }} " data - code = " { { data.code }} " data - type = " { { data.type }} " >
< div class = " notification-message customize-changeset-locked-message " >
2020-08-20 09:13:10 -04:00
< img class = " customize-changeset-locked-avatar " src = " { { data.lockUser.avatar }} " alt = " { { data.lockUser.name }} " />
2017-10-12 00:01:46 -04:00
< p class = " currently-editing " >
< # if ( data.message ) { #>
{{{ data . message }}}
< # } else if ( data.allowOverride ) { #>
< ? php
2018-01-22 01:28:31 -05:00
echo esc_html ( sprintf ( $l10n [ 'locked_allow_override' ], '{{ data.lockUser.name }}' ) );
2017-10-12 00:01:46 -04:00
?>
< # } else { #>
< ? php
2018-01-22 01:28:31 -05:00
echo esc_html ( sprintf ( $l10n [ 'locked' ], '{{ data.lockUser.name }}' ) );
2017-10-12 00:01:46 -04:00
?>
< # } #>
</ p >
< p class = " notice notice-error notice-alt " hidden ></ p >
< p class = " action-buttons " >
< # if ( data.returnUrl !== data.previewUrl ) { #>
< a class = " button customize-notice-go-back-button " href = " { { data.returnUrl }} " >< ? php _e ( 'Go back' ); ?> </a>
< # } #>
< a class = " button customize-notice-preview-button " href = " { { data.frontendPreviewUrl }} " >< ? php _e ( 'Preview' ); ?> </a>
< # if ( data.allowOverride ) { #>
< button class = " button button-primary wp-tab-last customize-notice-take-over-button " >< ? php _e ( 'Take over' ); ?> </button>
< # } #>
</ p >
</ div >
</ li >
</ script >
2017-11-13 17:46:34 -05:00
< script type = " text/html " id = " tmpl-customize-code-editor-lint-error-notification " >
< li class = " notice notice- { { data.type || 'info' }} { { data.alt ? 'notice-alt' : '' }} { { data.dismissible ? 'is-dismissible' : '' }} { { data.containerClasses || '' }} " data - code = " { { data.code }} " data - type = " { { data.type }} " >
< div class = " notification-message " > {{{ data . message || data . code }}} </ div >
< p >
< # var elementId = 'el-' + String( Math.random() ); #>
< input id = " { { elementId }} " type = " checkbox " >
< label for = " { { elementId }} " >< ? php _e ( 'Update anyway, even though it might break your site?' ); ?> </label>
</ p >
</ li >
</ script >
Customize: Add global notifications area.
* Displays an error notification in the global area when a save attempt is rejected due to invalid settings. An error notification is also displayed when saving fails due to a network error or server error.
* Introduces `wp.customize.Notifications` subclass of `wp.customize.Values` to contain instances of `wp.customize.Notification` and manage their rendering into a container.
* Exposes the global notification area as `wp.customize.notifications` collection instance.
* Updates the `notifications` object on `Control` to use `Notifications` rather than `Values` and to re-use the rendering logic from the former. The old `Control#renderNotifications` method is deprecated.
* Allows notifications to be dismissed by instantiating them with a `dismissible` property.
* Allows `wp.customize.Notification` to be extended with custom templates and `render` functions.
* Triggers a `removed` event on `wp.customize.Values` instances _after_ a value has been removed from the collection.
Props delawski, westonruter, karmatosed, celloexpressions, Fab1en, melchoyce, Kelderic, afercia, adamsilverstein.
See #34893, #39896.
Fixes #35210, #31582, #37727, #37269.
Built from https://develop.svn.wordpress.org/trunk@41374
git-svn-id: http://core.svn.wordpress.org/trunk@41207 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-12 03:03:46 -04:00
< ? php
/* The following template is obsolete in core but retained for plugins. */
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
?>
< script type = " text/html " id = " tmpl-customize-control-notifications " >
< ul >
< # _.each( data.notifications, function( notification ) { #>
2016-10-19 14:15:31 -04:00
< li class = " notice notice- { { notification.type || 'info' }} { { data.altNotice ? 'notice-alt' : '' }} " data - code = " { { notification.code }} " data - type = " { { notification.type }} " > {{{ notification . message || notification . code }}} </ li >
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
< # } ); #>
</ ul >
</ script >
2017-10-04 22:56:47 -04:00
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
< script type = " text/html " id = " tmpl-customize-preview-link-control " >
2017-10-02 00:12:47 -04:00
< # var elementPrefix = _.uniqueId( 'el' ) + '-' #>
< p class = " customize-control-title " >
< ? php esc_html_e ( 'Share Preview Link' ); ?>
</ p >
< p class = " description customize-control-description " >< ? php esc_html_e ( 'See how changes would look live on your website, and share the preview with people who can\'t access the Customizer.' ); ?> </p>
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
< div class = " customize-control-notifications-container " ></ div >
< div class = " preview-link-wrapper " >
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
< label for = " { { elementPrefix }}customize-preview-link-input " class = " screen-reader-text " >
< ? php
/* translators: Hidden accessibility text. */
esc_html_e ( 'Preview Link' );
?>
</ label >
2017-10-02 00:12:47 -04:00
< a href = " " target = " " >
< span class = " preview-control-element " data - component = " url " ></ span >
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
< span class = " screen-reader-text " >
< ? php
/* translators: Hidden accessibility text. */
_e ( '(opens in a new tab)' );
?>
</ span >
2017-10-02 00:12:47 -04:00
</ a >
2017-10-09 19:01:46 -04:00
< input id = " { { elementPrefix }}customize-preview-link-input " readonly tabindex = " -1 " class = " preview-control-element " data - component = " input " >
2017-10-02 00:12:47 -04:00
< button class = " customize-copy-preview-link preview-control-element button button-secondary " data - component = " button " data - copy - text = " <?php esc_attr_e( 'Copy' ); ?> " data - copied - text = " <?php esc_attr_e( 'Copied' ); ?> " >< ? php esc_html_e ( 'Copy' ); ?> </button>
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
</ div >
</ script >
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
< script type = " text/html " id = " tmpl-customize-selected-changeset-status-control " >
< # var inputId = _.uniqueId( 'customize-selected-changeset-status-control-input-' ); #>
< # var descriptionId = _.uniqueId( 'customize-selected-changeset-status-control-description-' ); #>
< # if ( data.label ) { #>
< label for = " { { inputId }} " class = " customize-control-title " > {{ data . label }} </ label >
< # } #>
< # if ( data.description ) { #>
< span id = " { { descriptionId }} " class = " description customize-control-description " > {{{ data . description }}} </ span >
< # } #>
< # _.each( data.choices, function( choice ) { #>
< # var choiceId = inputId + '-' + choice.status; #>
< span class = " customize-inside-control-row " >
< input id = " { { choiceId }} " type = " radio " value = " { { choice.status }} " name = " { { inputId }} " data - customize - setting - key - link = " default " >
< label for = " { { choiceId }} " > {{ choice . label }} </ label >
</ span >
< # } ); #>
</ script >
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
< ? php
2014-10-24 12:32:18 -04:00
}
2014-11-03 16:35:23 -05:00
/**
* Helper function to compare two objects by priority , ensuring sort stability via instance_number .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
2016-10-25 17:26:32 -04:00
* @ deprecated 4.7 . 0 Use wp_list_sort ()
2012-02-24 23:12:43 -05:00
*
2015-01-16 13:37:24 -05:00
* @ param WP_Customize_Panel | WP_Customize_Section | WP_Customize_Control $a Object A .
* @ param WP_Customize_Panel | WP_Customize_Section | WP_Customize_Control $b Object B .
2012-07-26 17:45:33 -04:00
* @ return int
2012-02-24 23:12:43 -05:00
*/
2015-01-08 01:10:46 -05:00
protected function _cmp_priority ( $a , $b ) {
2016-10-25 17:26:32 -04:00
_deprecated_function ( __METHOD__ , '4.7.0' , 'wp_list_sort' );
2014-11-03 16:35:23 -05:00
if ( $a -> priority === $b -> priority ) {
2015-11-06 01:58:25 -05:00
return $a -> instance_number - $b -> instance_number ;
2014-11-03 16:35:23 -05:00
} else {
return $a -> priority - $b -> priority ;
}
2012-02-24 23:12:43 -05:00
}
/**
2022-04-02 12:21:05 -04:00
* Prepares panels , sections , and controls .
2012-02-24 23:12:43 -05:00
*
2014-03-04 15:21:14 -05:00
* For each , check if required related components exist ,
* whether the user has the necessary capabilities ,
* and sort by priority .
*
2012-02-24 23:12:43 -05:00
* @ since 3.4 . 0
*/
public function prepare_controls () {
2017-11-30 18:11:00 -05:00
$controls = array ();
$this -> controls = wp_list_sort (
2018-08-16 21:51:36 -04:00
$this -> controls ,
array (
2017-11-30 18:11:00 -05:00
'priority' => 'ASC' ,
'instance_number' => 'ASC' ,
2018-08-16 21:51:36 -04:00
),
'ASC' ,
true
2017-11-30 18:11:00 -05:00
);
2012-03-21 18:55:43 -04:00
2012-03-28 00:14:09 -04:00
foreach ( $this -> controls as $id => $control ) {
2014-06-26 16:17:15 -04:00
if ( ! isset ( $this -> sections [ $control -> section ] ) || ! $control -> check_capabilities () ) {
2012-02-24 23:12:43 -05:00
continue ;
2014-06-26 16:17:15 -04:00
}
2012-02-24 23:12:43 -05:00
2012-03-28 00:14:09 -04:00
$this -> sections [ $control -> section ] -> controls [] = $control ;
2017-11-30 18:11:00 -05:00
$controls [ $id ] = $control ;
2012-02-24 23:12:43 -05:00
}
2012-03-28 00:14:09 -04:00
$this -> controls = $controls ;
2012-03-21 18:55:43 -04:00
2014-03-04 15:21:14 -05:00
// Prepare sections.
2017-11-30 18:11:00 -05:00
$this -> sections = wp_list_sort (
2018-08-16 21:51:36 -04:00
$this -> sections ,
array (
2017-11-30 18:11:00 -05:00
'priority' => 'ASC' ,
'instance_number' => 'ASC' ,
2018-08-16 21:51:36 -04:00
),
'ASC' ,
true
2017-11-30 18:11:00 -05:00
);
$sections = array ();
2012-02-24 23:12:43 -05:00
foreach ( $this -> sections as $section ) {
2015-06-12 18:54:25 -04:00
if ( ! $section -> check_capabilities () ) {
2012-03-21 18:55:43 -04:00
continue ;
2014-06-26 16:17:15 -04:00
}
2012-03-21 18:55:43 -04:00
2017-11-30 18:11:00 -05:00
$section -> controls = wp_list_sort (
2018-08-16 21:51:36 -04:00
$section -> controls ,
array (
2017-11-30 18:11:00 -05:00
'priority' => 'ASC' ,
'instance_number' => 'ASC' ,
)
);
2014-06-26 16:17:15 -04:00
if ( ! $section -> panel ) {
// Top-level section.
Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.
* Introduce models for panels and sections.
* Introduce API to expand and focus a control, section or panel.
* Allow deep-linking to panels, sections, and controls inside of the Customizer.
* Clean up `accordion.js`, removing all Customizer-specific logic.
* Add initial unit tests for `wp.customize.Class` in `customize-base.js`.
https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.
props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.
Built from https://develop.svn.wordpress.org/trunk@30102
git-svn-id: http://core.svn.wordpress.org/trunk@30102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-29 18:51:22 -04:00
$sections [ $section -> id ] = $section ;
2014-06-26 16:17:15 -04:00
} else {
// This section belongs to a panel.
if ( isset ( $this -> panels [ $section -> panel ] ) ) {
Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.
* Introduce models for panels and sections.
* Introduce API to expand and focus a control, section or panel.
* Allow deep-linking to panels, sections, and controls inside of the Customizer.
* Clean up `accordion.js`, removing all Customizer-specific logic.
* Add initial unit tests for `wp.customize.Class` in `customize-base.js`.
https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.
props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.
Built from https://develop.svn.wordpress.org/trunk@30102
git-svn-id: http://core.svn.wordpress.org/trunk@30102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-29 18:51:22 -04:00
$this -> panels [ $section -> panel ] -> sections [ $section -> id ] = $section ;
2014-06-26 16:17:15 -04:00
}
}
2012-03-21 18:55:43 -04:00
}
$this -> sections = $sections ;
2014-06-26 16:17:15 -04:00
// Prepare panels.
2017-11-30 18:11:00 -05:00
$this -> panels = wp_list_sort (
2018-08-16 21:51:36 -04:00
$this -> panels ,
array (
2017-11-30 18:11:00 -05:00
'priority' => 'ASC' ,
'instance_number' => 'ASC' ,
2018-08-16 21:51:36 -04:00
),
'ASC' ,
true
2017-11-30 18:11:00 -05:00
);
$panels = array ();
2014-06-26 16:17:15 -04:00
foreach ( $this -> panels as $panel ) {
2015-06-12 18:54:25 -04:00
if ( ! $panel -> check_capabilities () ) {
2014-06-26 16:17:15 -04:00
continue ;
}
2017-11-30 18:11:00 -05:00
$panel -> sections = wp_list_sort (
2018-08-16 21:51:36 -04:00
$panel -> sections ,
array (
2017-11-30 18:11:00 -05:00
'priority' => 'ASC' ,
'instance_number' => 'ASC' ,
2018-08-16 21:51:36 -04:00
),
'ASC' ,
true
2017-11-30 18:11:00 -05:00
);
Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.
* Introduce models for panels and sections.
* Introduce API to expand and focus a control, section or panel.
* Allow deep-linking to panels, sections, and controls inside of the Customizer.
* Clean up `accordion.js`, removing all Customizer-specific logic.
* Add initial unit tests for `wp.customize.Class` in `customize-base.js`.
https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.
props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.
Built from https://develop.svn.wordpress.org/trunk@30102
git-svn-id: http://core.svn.wordpress.org/trunk@30102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-29 18:51:22 -04:00
$panels [ $panel -> id ] = $panel ;
2014-06-26 16:17:15 -04:00
}
$this -> panels = $panels ;
2014-08-14 00:43:16 -04:00
// Sort panels and top-level sections together.
$this -> containers = array_merge ( $this -> panels , $this -> sections );
2017-11-30 18:11:00 -05:00
$this -> containers = wp_list_sort (
2018-08-16 21:51:36 -04:00
$this -> containers ,
array (
2017-11-30 18:11:00 -05:00
'priority' => 'ASC' ,
'instance_number' => 'ASC' ,
2018-08-16 21:51:36 -04:00
),
'ASC' ,
true
2017-11-30 18:11:00 -05:00
);
2012-03-21 18:55:43 -04:00
}
/**
2022-04-02 12:21:05 -04:00
* Enqueues scripts for customize controls .
2012-03-21 18:55:43 -04:00
*
* @ since 3.4 . 0
*/
public function enqueue_control_scripts () {
2012-03-28 00:14:09 -04:00
foreach ( $this -> controls as $control ) {
$control -> enqueue ();
2012-02-24 23:12:43 -05:00
}
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
if ( ! is_multisite () && ( current_user_can ( 'install_themes' ) || current_user_can ( 'update_themes' ) || current_user_can ( 'delete_themes' ) ) ) {
wp_enqueue_script ( 'updates' );
2017-11-30 18:11:00 -05:00
wp_localize_script (
2018-08-16 21:51:36 -04:00
'updates' ,
'_wpUpdatesItemCounts' ,
array (
2017-11-30 18:11:00 -05:00
'totals' => wp_get_update_data (),
)
);
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
}
2012-02-24 23:12:43 -05:00
}
2015-09-17 15:42:26 -04:00
/**
2022-04-02 12:21:05 -04:00
* Determines whether the user agent is iOS .
2015-09-17 15:42:26 -04:00
*
* @ since 4.4 . 0
*
2015-09-19 02:40:26 -04:00
* @ return bool Whether the user agent is iOS .
2015-09-17 15:42:26 -04:00
*/
public function is_ios () {
return wp_is_mobile () && preg_match ( '/iPad|iPod|iPhone/' , $_SERVER [ 'HTTP_USER_AGENT' ] );
}
/**
2022-04-02 12:21:05 -04:00
* Gets the template string for the Customizer pane document title .
2015-09-17 15:42:26 -04:00
*
* @ since 4.4 . 0
*
2015-09-19 02:40:26 -04:00
* @ return string The template string for the document title .
2015-09-17 15:42:26 -04:00
*/
public function get_document_title_template () {
if ( $this -> is_theme_active () ) {
2019-09-02 20:41:05 -04:00
/* translators: %s: Document title from the preview. */
2015-10-07 19:54:24 -04:00
$document_title_tmpl = __ ( 'Customize: %s' );
2015-09-17 15:42:26 -04:00
} else {
2019-09-02 20:41:05 -04:00
/* translators: %s: Document title from the preview. */
2015-10-07 19:54:24 -04:00
$document_title_tmpl = __ ( 'Live Preview: %s' );
2015-09-17 15:42:26 -04:00
}
$document_title_tmpl = html_entity_decode ( $document_title_tmpl , ENT_QUOTES , 'UTF-8' ); // Because exported to JS and assigned to document.title.
return $document_title_tmpl ;
}
/**
2022-04-02 12:21:05 -04:00
* Sets the initial URL to be previewed .
2015-09-17 15:42:26 -04:00
*
* URL is validated .
*
* @ since 4.4 . 0
*
2015-09-19 02:40:26 -04:00
* @ param string $preview_url URL to be previewed .
2015-09-17 15:42:26 -04:00
*/
public function set_preview_url ( $preview_url ) {
2022-06-01 14:14:10 -04:00
$preview_url = sanitize_url ( $preview_url );
2015-09-17 15:42:26 -04:00
$this -> preview_url = wp_validate_redirect ( $preview_url , home_url ( '/' ) );
}
/**
2022-04-02 12:21:05 -04:00
* Gets the initial URL to be previewed .
2015-09-17 15:42:26 -04:00
*
* @ since 4.4 . 0
*
2015-09-19 02:40:26 -04:00
* @ return string URL being previewed .
2015-09-17 15:42:26 -04:00
*/
public function get_preview_url () {
if ( empty ( $this -> preview_url ) ) {
$preview_url = home_url ( '/' );
} else {
$preview_url = $this -> preview_url ;
}
return $preview_url ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/**
* Determines whether the admin and the frontend are on different domains .
*
* @ since 4.7 . 0
*
* @ return bool Whether cross - domain .
*/
public function is_cross_domain () {
$admin_origin = wp_parse_url ( admin_url () );
2017-11-30 18:11:00 -05:00
$home_origin = wp_parse_url ( home_url () );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$cross_domain = ( strtolower ( $admin_origin [ 'host' ] ) !== strtolower ( $home_origin [ 'host' ] ) );
return $cross_domain ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets URLs allowed to be previewed .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* If the front end and the admin are served from the same domain , load the
* preview over ssl if the Customizer is being loaded over ssl . This avoids
* insecure content warnings . This is not attempted if the admin and front end
* are on different domains to avoid the case where the front end doesn ' t have
* ssl certs . Domain mapping plugins can allow other urls in these conditions
* using the customize_allowed_urls filter .
*
* @ since 4.7 . 0
*
2019-12-06 17:23:04 -05:00
* @ return array Allowed URLs .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*/
public function get_allowed_urls () {
$allowed_urls = array ( home_url ( '/' ) );
if ( is_ssl () && ! $this -> is_cross_domain () ) {
$allowed_urls [] = home_url ( '/' , 'https' );
}
/**
* Filters the list of URLs allowed to be clicked and followed in the Customizer preview .
*
* @ since 3.4 . 0
*
2018-03-25 14:10:32 -04:00
* @ param string [] $allowed_urls An array of allowed URLs .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*/
$allowed_urls = array_unique ( apply_filters ( 'customize_allowed_urls' , $allowed_urls ) );
return $allowed_urls ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets messenger channel .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
* @ since 4.7 . 0
*
* @ return string Messenger channel .
*/
public function get_messenger_channel () {
return $this -> messenger_channel ;
}
2015-09-17 15:42:26 -04:00
/**
2022-04-02 12:21:05 -04:00
* Sets URL to link the user to when closing the Customizer .
2015-09-17 15:42:26 -04:00
*
* URL is validated .
*
* @ since 4.4 . 0
*
2015-09-19 02:40:26 -04:00
* @ param string $return_url URL for return link .
2015-09-17 15:42:26 -04:00
*/
public function set_return_url ( $return_url ) {
2022-06-01 14:14:10 -04:00
$return_url = sanitize_url ( $return_url );
2017-11-30 18:11:00 -05:00
$return_url = remove_query_arg ( wp_removable_query_args (), $return_url );
$return_url = wp_validate_redirect ( $return_url );
2015-09-17 15:42:26 -04:00
$this -> return_url = $return_url ;
}
/**
2022-04-02 12:21:05 -04:00
* Gets URL to link the user to when closing the Customizer .
2015-09-17 15:42:26 -04:00
*
* @ since 4.4 . 0
*
2019-11-20 13:49:03 -05:00
* @ global array $_registered_pages
*
2015-09-19 02:40:26 -04:00
* @ return string URL for link to close Customizer .
2015-09-17 15:42:26 -04:00
*/
public function get_return_url () {
2019-11-20 13:49:03 -05:00
global $_registered_pages ;
2017-11-30 18:11:00 -05:00
$referer = wp_get_referer ();
2016-01-11 13:51:28 -05:00
$excluded_referer_basenames = array ( 'customize.php' , 'wp-login.php' );
2015-09-17 15:42:26 -04:00
if ( $this -> return_url ) {
$return_url = $this -> return_url ;
2022-09-12 17:50:14 -04:00
$return_url_basename = wp_basename ( parse_url ( $this -> return_url , PHP_URL_PATH ) );
$return_url_query = parse_url ( $this -> return_url , PHP_URL_QUERY );
if ( 'themes.php' === $return_url_basename && $return_url_query ) {
parse_str ( $return_url_query , $query_vars );
/*
* If the return URL is a page added by a theme to the Appearance menu via add_submenu_page (),
* verify that it belongs to the active theme , otherwise fall back to the Themes screen .
*/
if ( isset ( $query_vars [ 'page' ] ) && ! isset ( $_registered_pages [ " appearance_page_ { $query_vars [ 'page' ] } " ] ) ) {
$return_url = admin_url ( 'themes.php' );
}
}
2019-03-01 15:58:52 -05:00
} elseif ( $referer && ! in_array ( wp_basename ( parse_url ( $referer , PHP_URL_PATH ) ), $excluded_referer_basenames , true ) ) {
2015-11-01 01:40:28 -05:00
$return_url = $referer ;
2017-11-30 18:11:00 -05:00
} elseif ( $this -> preview_url ) {
2015-09-17 15:42:26 -04:00
$return_url = $this -> preview_url ;
} else {
2015-11-01 01:40:28 -05:00
$return_url = home_url ( '/' );
2015-09-17 15:42:26 -04:00
}
2019-11-20 13:49:03 -05:00
2015-09-17 15:42:26 -04:00
return $return_url ;
}
/**
2022-04-02 12:21:05 -04:00
* Sets the autofocused constructs .
2015-09-17 15:42:26 -04:00
*
2015-09-19 02:40:26 -04:00
* @ since 4.4 . 0
*
2015-09-17 15:42:26 -04:00
* @ param array $autofocus {
* Mapping of 'panel' , 'section' , 'control' to the ID which should be autofocused .
*
2020-07-23 03:39:02 -04:00
* @ type string $control ID for control to be autofocused .
* @ type string $section ID for section to be autofocused .
* @ type string $panel ID for panel to be autofocused .
2015-09-17 15:42:26 -04:00
* }
*/
public function set_autofocus ( $autofocus ) {
$this -> autofocus = array_filter ( wp_array_slice_assoc ( $autofocus , array ( 'panel' , 'section' , 'control' ) ), 'is_string' );
}
/**
2022-04-02 12:21:05 -04:00
* Gets the autofocused constructs .
2015-09-17 15:42:26 -04:00
*
* @ since 4.4 . 0
*
2021-12-07 07:20:02 -05:00
* @ return string [] {
2015-09-17 15:42:26 -04:00
* Mapping of 'panel' , 'section' , 'control' to the ID which should be autofocused .
*
2020-07-23 03:39:02 -04:00
* @ type string $control ID for control to be autofocused .
* @ type string $section ID for section to be autofocused .
* @ type string $panel ID for panel to be autofocused .
2015-09-17 15:42:26 -04:00
* }
*/
public function get_autofocus () {
return $this -> autofocus ;
}
2016-01-27 12:55:26 -05:00
/**
2022-04-02 12:21:05 -04:00
* Gets nonces for the Customizer .
2016-01-27 12:55:26 -05:00
*
* @ since 4.5 . 0
2017-05-19 16:25:41 -04:00
*
2016-01-27 12:55:26 -05:00
* @ return array Nonces .
*/
public function get_nonces () {
$nonces = array (
2017-11-30 18:11:00 -05:00
'save' => wp_create_nonce ( 'save-customize_' . $this -> get_stylesheet () ),
'preview' => wp_create_nonce ( 'preview-customize_' . $this -> get_stylesheet () ),
'switch_themes' => wp_create_nonce ( 'switch_themes' ),
2017-10-12 00:01:46 -04:00
'dismiss_autosave_or_lock' => wp_create_nonce ( 'customize_dismiss_autosave_or_lock' ),
2017-11-30 18:11:00 -05:00
'override_lock' => wp_create_nonce ( 'customize_override_changeset_lock' ),
'trash' => wp_create_nonce ( 'trash_customize_changeset' ),
2016-01-27 12:55:26 -05:00
);
/**
2016-05-22 14:10:29 -04:00
* Filters nonces for Customizer .
2016-01-27 12:55:26 -05:00
*
* @ since 4.2 . 0
*
2021-07-30 15:35:58 -04:00
* @ param string [] $nonces Array of refreshed nonces for save and
* preview actions .
* @ param WP_Customize_Manager $manager WP_Customize_Manager instance .
2016-01-27 12:55:26 -05:00
*/
$nonces = apply_filters ( 'customize_refresh_nonces' , $nonces , $this );
return $nonces ;
}
2015-09-17 15:42:26 -04:00
/**
2022-04-02 12:21:05 -04:00
* Prints JavaScript settings for parent window .
2015-09-17 15:42:26 -04:00
*
2015-09-19 02:40:26 -04:00
* @ since 4.4 . 0
2015-09-17 15:42:26 -04:00
*/
public function customize_pane_settings () {
2017-11-30 18:11:00 -05:00
$login_url = add_query_arg (
array (
'interim-login' => 1 ,
'customize-login' => 1 ,
2018-08-16 21:51:36 -04:00
),
wp_login_url ()
2017-11-30 18:11:00 -05:00
);
2015-09-17 15:42:26 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
// Ensure dirty flags are set for modified settings.
foreach ( array_keys ( $this -> unsanitized_post_values () ) as $setting_id ) {
$setting = $this -> get_setting ( $setting_id );
if ( $setting ) {
$setting -> dirty = true ;
}
}
2017-11-30 18:11:00 -05:00
$autosave_revision_post = null ;
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
$autosave_autodraft_post = null ;
2017-11-30 18:11:00 -05:00
$changeset_post_id = $this -> changeset_post_id ();
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
if ( ! $this -> saved_starter_content_changeset && ! $this -> autosaved () ) {
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( $changeset_post_id ) {
2018-01-29 19:21:30 -05:00
if ( is_user_logged_in () ) {
$autosave_revision_post = wp_get_post_autosave ( $changeset_post_id , get_current_user_id () );
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
} else {
2017-11-30 18:11:00 -05:00
$autosave_autodraft_posts = $this -> get_changeset_posts (
array (
'posts_per_page' => 1 ,
'post_status' => 'auto-draft' ,
'exclude_restore_dismissed' => true ,
)
);
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( ! empty ( $autosave_autodraft_posts ) ) {
$autosave_autodraft_post = array_shift ( $autosave_autodraft_posts );
}
}
}
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
$current_user_can_publish = current_user_can ( get_post_type_object ( 'customize_changeset' ) -> cap -> publish_posts );
// @todo Include all of the status labels here from script-loader.php, and then allow it to be filtered.
$status_choices = array ();
if ( $current_user_can_publish ) {
$status_choices [] = array (
'status' => 'publish' ,
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Publish' ),
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
);
}
$status_choices [] = array (
'status' => 'draft' ,
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Save Draft' ),
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
);
if ( $current_user_can_publish ) {
$status_choices [] = array (
'status' => 'future' ,
2017-11-30 18:11:00 -05:00
'label' => _x ( 'Schedule' , 'customizer changeset action/button label' ),
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
);
}
2015-09-17 15:42:26 -04:00
// Prepare Customizer settings to pass to JavaScript.
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
$changeset_post = null ;
if ( $changeset_post_id ) {
$changeset_post = get_post ( $changeset_post_id );
}
2017-11-02 16:00:48 -04:00
// Determine initial date to be at present or future, not past.
$current_time = current_time ( 'mysql' , false );
$initial_date = $current_time ;
if ( $changeset_post ) {
$initial_date = get_the_time ( 'Y-m-d H:i:s' , $changeset_post -> ID );
if ( $initial_date < $current_time ) {
$initial_date = $current_time ;
}
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
}
2017-10-12 00:01:46 -04:00
$lock_user_id = false ;
if ( $this -> changeset_post_id () ) {
$lock_user_id = wp_check_post_lock ( $this -> changeset_post_id () );
}
2015-09-17 15:42:26 -04:00
$settings = array (
2017-11-30 18:11:00 -05:00
'changeset' => array (
'uuid' => $this -> changeset_uuid (),
'branching' => $this -> branching (),
'autosaved' => $this -> autosaved (),
'hasAutosaveRevision' => ! empty ( $autosave_revision_post ),
'latestAutoDraftUuid' => $autosave_autodraft_post ? $autosave_autodraft_post -> post_name : null ,
'status' => $changeset_post ? $changeset_post -> post_status : '' ,
Customize: Allow controls to be created with pre-instantiated `Setting` object(s), or even with plain `Value` object(s).
* Allow passing settings in keyed object (e.g. `settings: { default: 'id' } ), or as an array (e.g. `settings: [ 'id' ]`) with first being default; again, `Setting`/`Value` objects may be supplied instead of IDs.
* Allow a single setting to be supplied with just a single `setting` param, either a string or a `Setting`/`Value` object.
* Update `changeset_status` and `scheduled_changeset_date` to be added dynamically with JS and simply passing of `api.state()` instances as `setting`.
* Introduce a `data-customize-setting-key-link` attribute which, unlike `data-customize-setting-link`, allows passing the setting key (e.g. `default`) as opposed to the setting ID.
* Allow `WP_Customize_Control::get_link()` to return `data-customize-setting-key-link` when setting is not registered.
* Eliminate `default_value` from `WP_Customize_Date_Time_Control` since now comes from supplied `Value`.
* Export status choices as `wp.customize.settings.changeset.statusChoices`.
* Export date and time formats as `wp.customize.settings.dateFormat` and `wp.customize.settings.timeFormat` respectively.
Props westonruter, sayedwp.
See #39896, #30738, #30741, #42083.
Fixes #37964, #36167.
Built from https://develop.svn.wordpress.org/trunk@41750
git-svn-id: http://core.svn.wordpress.org/trunk@41584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-04 16:02:49 -04:00
'currentUserCanPublish' => $current_user_can_publish ,
2017-11-30 18:11:00 -05:00
'publishDate' => $initial_date ,
'statusChoices' => $status_choices ,
'lockUser' => $lock_user_id ? $this -> get_lock_user_data ( $lock_user_id ) : null ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
),
2017-11-30 18:11:00 -05:00
'initialServerDate' => $current_time ,
'dateFormat' => get_option ( 'date_format' ),
'timeFormat' => get_option ( 'time_format' ),
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
'initialServerTimestamp' => floor ( microtime ( true ) * 1000 ),
'initialClientTimestamp' => - 1 , // To be set with JS below.
2017-11-30 18:11:00 -05:00
'timeouts' => array (
'windowRefresh' => 250 ,
'changesetAutoSave' => AUTOSAVE_INTERVAL * 1000 ,
'keepAliveCheck' => 2500 ,
'reflowPaneContents' => 100 ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'previewFrameSensitivity' => 2000 ,
),
2017-11-30 18:11:00 -05:00
'theme' => array (
2018-01-22 01:15:30 -05:00
'stylesheet' => $this -> get_stylesheet (),
'active' => $this -> is_theme_active (),
'_canInstall' => current_user_can ( 'install_themes' ),
2015-09-17 15:42:26 -04:00
),
2017-11-30 18:11:00 -05:00
'url' => array (
2022-06-01 14:14:10 -04:00
'preview' => sanitize_url ( $this -> get_preview_url () ),
'return' => sanitize_url ( $this -> get_return_url () ),
'parent' => sanitize_url ( admin_url () ),
'activated' => sanitize_url ( home_url ( '/' ) ),
'ajax' => sanitize_url ( admin_url ( 'admin-ajax.php' , 'relative' ) ),
'allowed' => array_map ( 'sanitize_url' , $this -> get_allowed_urls () ),
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
'isCrossDomain' => $this -> is_cross_domain (),
2022-06-01 14:14:10 -04:00
'home' => sanitize_url ( home_url ( '/' ) ),
'login' => sanitize_url ( $login_url ),
2015-09-17 15:42:26 -04:00
),
2017-11-30 18:11:00 -05:00
'browser' => array (
2015-09-17 15:42:26 -04:00
'mobile' => wp_is_mobile (),
'ios' => $this -> is_ios (),
),
2017-11-30 18:11:00 -05:00
'panels' => array (),
'sections' => array (),
'nonce' => $this -> get_nonces (),
'autofocus' => $this -> get_autofocus (),
'documentTitleTmpl' => $this -> get_document_title_template (),
'previewableDevices' => $this -> get_previewable_devices (),
'l10n' => array (
'confirmDeleteTheme' => __ ( 'Are you sure you want to delete this theme?' ),
2019-09-02 20:41:05 -04:00
/* translators: %d: Number of theme search results, which cannot currently consider singular vs. plural forms. */
2017-11-30 18:11:00 -05:00
'themeSearchResults' => __ ( '%d themes found' ),
2019-09-02 20:41:05 -04:00
/* translators: %d: Number of themes being displayed, which cannot currently consider singular vs. plural forms. */
2017-11-30 18:11:00 -05:00
'announceThemeCount' => __ ( 'Displaying %d themes' ),
2019-09-02 20:41:05 -04:00
/* translators: %s: Theme name. */
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
'announceThemeDetails' => __ ( 'Showing details for theme: %s' ),
),
2015-09-17 15:42:26 -04:00
);
2017-10-24 15:06:47 -04:00
// Temporarily disable installation in Customizer. See #42184.
$filesystem_method = get_filesystem_method ();
ob_start ();
$filesystem_credentials_are_stored = request_filesystem_credentials ( self_admin_url () );
ob_end_clean ();
if ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored ) {
$settings [ 'theme' ][ '_filesystemCredentialsNeeded' ] = true ;
}
2015-09-17 15:42:26 -04:00
// Prepare Customize Section objects to pass to JavaScript.
foreach ( $this -> sections () as $id => $section ) {
if ( $section -> check_capabilities () ) {
$settings [ 'sections' ][ $id ] = $section -> json ();
}
}
// Prepare Customize Panel objects to pass to JavaScript.
foreach ( $this -> panels () as $panel_id => $panel ) {
if ( $panel -> check_capabilities () ) {
$settings [ 'panels' ][ $panel_id ] = $panel -> json ();
foreach ( $panel -> sections as $section_id => $section ) {
if ( $section -> check_capabilities () ) {
$settings [ 'sections' ][ $section_id ] = $section -> json ();
}
}
}
}
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
ob_start ();
2015-09-17 15:42:26 -04:00
?>
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
< script >
2015-09-17 15:42:26 -04:00
var _wpCustomizeSettings = < ? php echo wp_json_encode ( $settings ); ?> ;
Customize: Introduce drafting and scheduling for Customizer changesets.
* Incorporates code from the Customize Snapshots and Customize Posts feature plugins.
* Adds a new Publish Settings section for managing the changeset status, scheduled date, and frontend preview link.
* Updates Publish button to reflect the status selected in the Publish Settings (including Save Draft and Schedule).
* Deactivates the Themes section when a non-publish status selected, and deactivates the Publish Settings section when previewing a theme switch.
* Introduces an `outer` section type (`wp.customize.OuterSection` in JS) for the Publish Settings section to use and for available widgets and available nav menu panels to use in the future. These sections can be expanded while other sections are expanded.
* Introduces `WP_Customize_Date_Time_Control` in PHP and `wp.customize.DateTimeControl` in JS for managing a date/time value.
* Keeps track of scheduled time and proactively publish from the client when the time arrives, as opposed to waiting for WP Cron.
* Auto-publishes a scheduled changeset when attempting to access one that missed its schedule.
* Starts a new changeset if attempting to save a changeset that was previously publish.
* Adds `force` arg to `requestChangesetUpdate()` to force an update request even when there are no pending changes.
* Adds utils methods for `getCurrentTimestamp` and `getRemainingTime`.
* Adds new state values for `selectedChangesetStatus`, `changesetDate`, `selectedChangesetDate`.
* Fixes logic for when to short-circuit check to close Customizer when there are unsaved changes.
* Adds getter methods for `autosaved` and `branching` parameters, with the latter applying the `customize_changeset_branching` filter.
* Call to `establish_loaded_changeset` on the fly when `changeset_uuid()` is called if no changeset UUID was specififed.
* De-duplicates logic for dismissing auto-draft changesets.
* Includes unit tests.
Builds on [41597].
Props sayedwp, westonruter, melchoyce, JoshuaWold, folletto, stubgo, karmatosed, dlh, paaljoachim, afercia, johnregan3, utkarshpatel, valendesigns.
See #30937.
Fixes #39896, #28721, #39275.
Built from https://develop.svn.wordpress.org/trunk@41626
git-svn-id: http://core.svn.wordpress.org/trunk@41461 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-27 18:25:46 -04:00
_wpCustomizeSettings . initialClientTimestamp = _ . now ();
2015-09-17 15:42:26 -04:00
_wpCustomizeSettings . controls = {};
_wpCustomizeSettings . settings = {};
< ? php
// Serialize settings one by one to improve memory usage.
echo " (function ( s ) { \n " ;
foreach ( $this -> settings () as $setting ) {
if ( $setting -> check_capabilities () ) {
printf (
" s[%s] = %s; \n " ,
wp_json_encode ( $setting -> id ),
Customize: Add setting validation model and control notifications to augment setting sanitization.
When a setting is invalid, not only will it be blocked from being saved but all other settings will be blocked as well. This ensures that Customizer saves aren't partial but are more transactional. User will be displayed the error in a notification so that they can fix and re-attempt saving.
PHP changes:
* Introduces `WP_Customize_Setting::validate()`, `WP_Customize_Setting::$validate_callback`, and the `customize_validate_{$setting_id}` filter.
* Introduces `WP_Customize_Manager::validate_setting_values()` to do validation (and sanitization) for the setting values supplied, returning a list of `WP_Error` instances for invalid settings.
* Attempting to save settings that are invalid will result in the save being blocked entirely, with the errors being sent in the `customize_save_response`. Modifies `WP_Customize_Manager::save()` to check all settings for validity issues prior to calling their `save` methods.
* Introduces `WP_Customize_Setting::json()` for parity with the other Customizer classes. This includes exporting of the `type`.
* Modifies `WP_Customize_Manager::post_value()` to apply `validate` after `sanitize`, and if validation fails, to return the `$default`.
* Introduces `customize_save_validation_before` action which fires right before the validation checks are made prior to saving.
JS changes:
* Introduces `wp.customize.Notification` in JS which to represent `WP_Error` instances returned from the server when setting validation fails.
* Introduces `wp.customize.Setting.prototype.notifications`.
* Introduces `wp.customize.Control.prototype.notifications`, which are synced with a control's settings' notifications.
* Introduces `wp.customize.Control.prototype.renderNotifications()` to re-render a control's notifications in its notification area. This is called automatically when the notifications collection changes.
* Introduces `wp.customize.settingConstructor`, allowing custom setting types to be used in the same way that custom controls, panels, and sections can be made.
* Injects a notification area into existing controls which is populated in response to the control's `notifications` collection changing. A custom control can customize the placement of the notification area by overriding the new `getNotificationsContainerElement` method.
* When a save fails due to setting invalidity, the invalidity errors will be added to the settings to then populate in the controls' notification areas, and the first such invalid control will be focused.
Props westonruter, celloexpressions, mrahmadawais.
See #35210.
See #30937.
Fixes #34893.
Built from https://develop.svn.wordpress.org/trunk@37476
git-svn-id: http://core.svn.wordpress.org/trunk@37444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-20 17:10:27 -04:00
wp_json_encode ( $setting -> json () )
2015-09-17 15:42:26 -04:00
);
}
}
echo " })( _wpCustomizeSettings.settings ); \n " ;
// Serialize controls one by one to improve memory usage.
echo " (function ( c ) { \n " ;
foreach ( $this -> controls () as $control ) {
if ( $control -> check_capabilities () ) {
printf (
" c[%s] = %s; \n " ,
wp_json_encode ( $control -> id ),
wp_json_encode ( $control -> json () )
);
}
}
echo " })( _wpCustomizeSettings.controls ); \n " ;
2018-08-16 21:51:36 -04:00
?>
2015-09-17 15:42:26 -04:00
</ script >
< ? php
2023-09-29 15:47:21 -04:00
wp_print_inline_script_tag ( wp_remove_surrounding_empty_script_tags ( ob_get_clean () ) );
2015-09-17 15:42:26 -04:00
}
2016-02-15 20:57:26 -05:00
/**
* Returns a list of devices to allow previewing .
*
* @ since 4.5 . 0
*
* @ return array List of devices with labels and default setting .
*/
public function get_previewable_devices () {
$devices = array (
'desktop' => array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Enter desktop preview mode' ),
2016-02-15 20:57:26 -05:00
'default' => true ,
),
2017-11-30 18:11:00 -05:00
'tablet' => array (
2016-02-15 20:57:26 -05:00
'label' => __ ( 'Enter tablet preview mode' ),
),
2017-11-30 18:11:00 -05:00
'mobile' => array (
2016-02-15 20:57:26 -05:00
'label' => __ ( 'Enter mobile preview mode' ),
),
);
/**
2016-05-22 14:10:29 -04:00
* Filters the available devices to allow previewing in the Customizer .
2016-02-15 20:57:26 -05:00
*
* @ since 4.5 . 0
*
* @ see WP_Customize_Manager :: get_previewable_devices ()
*
* @ param array $devices List of devices with labels and default setting .
*/
$devices = apply_filters ( 'customize_previewable_devices' , $devices );
return $devices ;
}
2012-02-24 23:12:43 -05:00
/**
2022-04-02 12:21:05 -04:00
* Registers some default controls .
2012-02-24 23:12:43 -05:00
*
* @ since 3.4 . 0
*/
public function register_controls () {
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
/* Themes (controls are loaded via ajax) */
2015-02-24 15:31:24 -05:00
2017-11-30 18:11:00 -05:00
$this -> add_panel (
new WP_Customize_Themes_Panel (
2018-08-16 21:51:36 -04:00
$this ,
'themes' ,
array (
2017-11-30 18:11:00 -05:00
'title' => $this -> theme () -> display ( 'Name' ),
'description' => (
'<p>' . __ ( 'Looking for a theme? You can search or browse the WordPress.org theme directory, install and preview themes, then activate them right here.' ) . '</p>' .
'<p>' . __ ( 'While previewing a new theme, you can continue to tailor things like widgets and menus, and explore theme-specific options.' ) . '</p>'
),
'capability' => 'switch_themes' ,
'priority' => 0 ,
)
)
);
$this -> add_section (
new WP_Customize_Themes_Section (
2018-08-16 21:51:36 -04:00
$this ,
'installed_themes' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'Installed themes' ),
'action' => 'installed' ,
'capability' => 'switch_themes' ,
'panel' => 'themes' ,
'priority' => 0 ,
)
)
);
2015-02-24 15:31:24 -05:00
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
if ( ! is_multisite () ) {
2017-11-30 18:11:00 -05:00
$this -> add_section (
new WP_Customize_Themes_Section (
2018-08-16 21:51:36 -04:00
$this ,
'wporg_themes' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'WordPress.org themes' ),
'action' => 'wporg' ,
'filter_type' => 'remote' ,
'capability' => 'install_themes' ,
'panel' => 'themes' ,
'priority' => 5 ,
)
)
);
2016-11-04 13:18:26 -04:00
}
2016-10-24 14:17:39 -04:00
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
// Themes Setting (unused - the theme is considerably more fundamental to the Customizer experience).
2017-11-30 18:11:00 -05:00
$this -> add_setting (
new WP_Customize_Filter_Setting (
2018-08-16 21:51:36 -04:00
$this ,
'active_theme' ,
array (
2017-11-30 18:11:00 -05:00
'capability' => 'switch_themes' ,
)
)
);
2016-10-18 23:20:29 -04:00
2015-07-10 17:33:24 -04:00
/* Site Identity */
2012-02-24 23:12:43 -05:00
2017-11-30 18:11:00 -05:00
$this -> add_section (
2018-08-16 21:51:36 -04:00
'title_tagline' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'Site Identity' ),
'priority' => 20 ,
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'blogname' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_option ( 'blogname' ),
'type' => 'option' ,
'capability' => 'manage_options' ,
)
);
$this -> add_control (
2018-08-16 21:51:36 -04:00
'blogname' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Site Title' ),
'section' => 'title_tagline' ,
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'blogdescription' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_option ( 'blogdescription' ),
'type' => 'option' ,
'capability' => 'manage_options' ,
)
);
$this -> add_control (
2018-08-16 21:51:36 -04:00
'blogdescription' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Tagline' ),
'section' => 'title_tagline' ,
)
);
2012-05-25 15:52:54 -04:00
2016-03-10 00:37:27 -05:00
// Add a setting to hide header text if the theme doesn't support custom headers.
if ( ! current_theme_supports ( 'custom-header' , 'header-text' ) ) {
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'header_text' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-logo' , 'header-text' ),
'default' => 1 ,
'sanitize_callback' => 'absint' ,
)
);
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
2017-11-30 18:11:00 -05:00
$this -> add_control (
2018-08-16 21:51:36 -04:00
'header_text' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Display Site Title and Tagline' ),
'section' => 'title_tagline' ,
'settings' => 'header_text' ,
'type' => 'checkbox' ,
)
);
}
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'site_icon' ,
array (
2017-11-30 18:11:00 -05:00
'type' => 'option' ,
'capability' => 'manage_options' ,
'transport' => 'postMessage' , // Previewed with JS in the Customizer controls window.
)
);
$this -> add_control (
new WP_Customize_Site_Icon_Control (
2018-08-16 21:51:36 -04:00
$this ,
'site_icon' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Site Icon' ),
'description' => sprintf (
2024-02-27 15:21:14 -05:00
/* translators: %s: Site Icon size in pixels. */
2024-03-04 19:12:11 -05:00
'<p>' . __ ( 'The Site Icon is what you see in browser tabs, bookmark bars, and within the WordPress mobile apps. It should be square and at least %s pixels.' ) . '</p>' ,
2024-02-27 15:21:14 -05:00
'<code>512 × 512</code>'
2017-11-30 18:11:00 -05:00
),
'section' => 'title_tagline' ,
'priority' => 60 ,
'height' => 512 ,
'width' => 512 ,
)
)
);
2015-07-10 17:33:24 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'custom_logo' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-logo' ),
'transport' => 'postMessage' ,
)
);
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
2016-03-23 22:02:27 -04:00
$custom_logo_args = get_theme_support ( 'custom-logo' );
2017-11-30 18:11:00 -05:00
$this -> add_control (
new WP_Customize_Cropped_Image_Control (
2018-08-16 21:51:36 -04:00
$this ,
'custom_logo' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Logo' ),
'section' => 'title_tagline' ,
'priority' => 8 ,
2019-07-15 02:25:57 -04:00
'height' => isset ( $custom_logo_args [ 0 ][ 'height' ] ) ? $custom_logo_args [ 0 ][ 'height' ] : null ,
'width' => isset ( $custom_logo_args [ 0 ][ 'width' ] ) ? $custom_logo_args [ 0 ][ 'width' ] : null ,
'flex_height' => isset ( $custom_logo_args [ 0 ][ 'flex-height' ] ) ? $custom_logo_args [ 0 ][ 'flex-height' ] : null ,
'flex_width' => isset ( $custom_logo_args [ 0 ][ 'flex-width' ] ) ? $custom_logo_args [ 0 ][ 'flex-width' ] : null ,
2017-11-30 18:11:00 -05:00
'button_labels' => array (
'select' => __ ( 'Select logo' ),
'change' => __ ( 'Change logo' ),
'remove' => __ ( 'Remove' ),
'default' => __ ( 'Default' ),
'placeholder' => __ ( 'No logo selected' ),
'frame_title' => __ ( 'Select logo' ),
'frame_button' => __ ( 'Choose logo' ),
),
)
)
);
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
2017-11-30 18:11:00 -05:00
$this -> selective_refresh -> add_partial (
2018-08-16 21:51:36 -04:00
'custom_logo' ,
array (
2017-11-30 18:11:00 -05:00
'settings' => array ( 'custom_logo' ),
'selector' => '.custom-logo-link' ,
'render_callback' => array ( $this , '_render_custom_logo_partial' ),
'container_inclusive' => true ,
)
);
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
2012-05-25 15:52:54 -04:00
/* Colors */
2017-11-30 18:11:00 -05:00
$this -> add_section (
2018-08-16 21:51:36 -04:00
'colors' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'Colors' ),
'priority' => 40 ,
)
);
2012-02-24 23:12:43 -05:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'header_textcolor' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-header' , 'header-text' ),
'default' => get_theme_support ( 'custom-header' , 'default-text-color' ),
2012-05-26 14:44:31 -04:00
2017-11-30 18:11:00 -05:00
'sanitize_callback' => array ( $this , '_sanitize_header_textcolor' ),
'sanitize_js_callback' => 'maybe_hash_hex_color' ,
)
);
2012-03-28 00:14:09 -04:00
2023-07-09 16:17:29 -04:00
// Input type: checkbox, with custom value.
2017-11-30 18:11:00 -05:00
$this -> add_control (
2018-08-16 21:51:36 -04:00
'display_header_text' ,
array (
2017-11-30 18:11:00 -05:00
'settings' => 'header_textcolor' ,
'label' => __ ( 'Display Site Title and Tagline' ),
'section' => 'title_tagline' ,
'type' => 'checkbox' ,
'priority' => 40 ,
)
);
$this -> add_control (
new WP_Customize_Color_Control (
2018-08-16 21:51:36 -04:00
$this ,
'header_textcolor' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Header Text Color' ),
'section' => 'colors' ,
)
)
);
2012-02-24 23:12:43 -05:00
2023-07-09 16:17:29 -04:00
// Input type: color, with sanitize_callback.
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_color' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-color' ),
'theme_supports' => 'custom-background' ,
'sanitize_callback' => 'sanitize_hex_color_no_hash' ,
'sanitize_js_callback' => 'maybe_hash_hex_color' ,
)
);
2012-03-28 00:14:09 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_control (
new WP_Customize_Color_Control (
2018-08-16 21:51:36 -04:00
$this ,
'background_color' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Background Color' ),
'section' => 'colors' ,
)
)
);
2012-03-15 00:14:05 -04:00
2012-05-25 15:52:54 -04:00
/* Custom Header */
2016-10-27 17:51:31 -04:00
if ( current_theme_supports ( 'custom-header' , 'video' ) ) {
2017-11-30 18:11:00 -05:00
$title = __ ( 'Header Media' );
2016-11-14 22:47:30 -05:00
$description = '<p>' . __ ( 'If you add a video, the image will be used as a fallback while the video loads.' ) . '</p>' ;
2017-11-30 18:11:00 -05:00
$width = absint ( get_theme_support ( 'custom-header' , 'width' ) );
2016-10-27 17:51:31 -04:00
$height = absint ( get_theme_support ( 'custom-header' , 'height' ) );
if ( $width && $height ) {
2016-11-15 15:54:30 -05:00
$control_description = sprintf (
2019-09-02 20:41:05 -04:00
/* translators: 1: .mp4, 2: Header size in pixels. */
2016-11-15 15:54:30 -05:00
__ ( 'Upload your video in %1$s format and minimize its file size for best results. Your theme recommends dimensions of %2$s pixels.' ),
'<code>.mp4</code>' ,
2016-10-27 17:51:31 -04:00
sprintf ( '<strong>%s × %s</strong>' , $width , $height )
);
} elseif ( $width ) {
2016-11-15 15:54:30 -05:00
$control_description = sprintf (
2019-09-02 20:41:05 -04:00
/* translators: 1: .mp4, 2: Header width in pixels. */
2016-11-15 15:54:30 -05:00
__ ( 'Upload your video in %1$s format and minimize its file size for best results. Your theme recommends a width of %2$s pixels.' ),
'<code>.mp4</code>' ,
2016-10-27 17:51:31 -04:00
sprintf ( '<strong>%s</strong>' , $width )
);
} else {
2016-11-15 15:54:30 -05:00
$control_description = sprintf (
2019-09-02 20:41:05 -04:00
/* translators: 1: .mp4, 2: Header height in pixels. */
2016-11-15 15:54:30 -05:00
__ ( 'Upload your video in %1$s format and minimize its file size for best results. Your theme recommends a height of %2$s pixels.' ),
'<code>.mp4</code>' ,
2016-10-27 17:51:31 -04:00
sprintf ( '<strong>%s</strong>' , $height )
);
}
} else {
2017-11-30 18:11:00 -05:00
$title = __ ( 'Header Image' );
$description = '' ;
2016-10-27 17:51:31 -04:00
$control_description = '' ;
}
2017-11-30 18:11:00 -05:00
$this -> add_section (
2018-08-16 21:51:36 -04:00
'header_image' ,
array (
2017-11-30 18:11:00 -05:00
'title' => $title ,
'description' => $description ,
'theme_supports' => 'custom-header' ,
'priority' => 60 ,
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'header_video' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-header' , 'video' ),
'transport' => 'postMessage' ,
'sanitize_callback' => 'absint' ,
'validate_callback' => array ( $this , '_validate_header_video' ),
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'external_header_video' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-header' , 'video' ),
'transport' => 'postMessage' ,
'sanitize_callback' => array ( $this , '_sanitize_external_header_video' ),
'validate_callback' => array ( $this , '_validate_external_header_video' ),
)
);
$this -> add_setting (
new WP_Customize_Filter_Setting (
2018-08-16 21:51:36 -04:00
$this ,
'header_image' ,
array (
2017-11-30 18:11:00 -05:00
'default' => sprintf ( get_theme_support ( 'custom-header' , 'default-image' ), get_template_directory_uri (), get_stylesheet_directory_uri () ),
'theme_supports' => 'custom-header' ,
)
)
);
$this -> add_setting (
new WP_Customize_Header_Image_Setting (
2018-08-16 21:51:36 -04:00
$this ,
'header_image_data' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => 'custom-header' ,
)
)
);
2012-05-25 15:52:54 -04:00
2016-11-14 13:41:32 -05:00
/*
* Switch image settings to postMessage when video support is enabled since
* it entails that the_custom_header_markup () will be used , and thus selective
* refresh can be utilized .
*/
if ( current_theme_supports ( 'custom-header' , 'video' ) ) {
2017-11-30 18:11:00 -05:00
$this -> get_setting ( 'header_image' ) -> transport = 'postMessage' ;
2016-11-14 13:41:32 -05:00
$this -> get_setting ( 'header_image_data' ) -> transport = 'postMessage' ;
}
2017-11-30 18:11:00 -05:00
$this -> add_control (
new WP_Customize_Media_Control (
2018-08-16 21:51:36 -04:00
$this ,
'header_video' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-header' , 'video' ),
'label' => __ ( 'Header Video' ),
'description' => $control_description ,
'section' => 'header_image' ,
'mime_type' => 'video' ,
'active_callback' => 'is_header_video_active' ,
)
)
);
2016-10-27 17:51:31 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_control (
2018-08-16 21:51:36 -04:00
'external_header_video' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => array ( 'custom-header' , 'video' ),
'type' => 'url' ,
'description' => __ ( 'Or, enter a YouTube URL:' ),
'section' => 'header_image' ,
'active_callback' => 'is_header_video_active' ,
)
);
2016-10-27 17:51:31 -04:00
2012-05-25 15:52:54 -04:00
$this -> add_control ( new WP_Customize_Header_Image_Control ( $this ) );
2017-11-30 18:11:00 -05:00
$this -> selective_refresh -> add_partial (
2018-08-16 21:51:36 -04:00
'custom_header' ,
array (
2017-11-30 18:11:00 -05:00
'selector' => '#wp-custom-header' ,
'render_callback' => 'the_custom_header_markup' ,
'settings' => array ( 'header_video' , 'external_header_video' , 'header_image' ), // The image is used as a video fallback here.
'container_inclusive' => true ,
)
);
2016-10-27 17:51:31 -04:00
2012-05-25 15:52:54 -04:00
/* Custom Background */
2017-11-30 18:11:00 -05:00
$this -> add_section (
2018-08-16 21:51:36 -04:00
'background_image' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'Background Image' ),
'theme_supports' => 'custom-background' ,
'priority' => 80 ,
)
);
2012-05-25 15:52:54 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_image' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-image' ),
'theme_supports' => 'custom-background' ,
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
)
);
2012-03-28 00:14:09 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
new WP_Customize_Background_Image_Setting (
2018-08-16 21:51:36 -04:00
$this ,
'background_image_thumb' ,
array (
2017-11-30 18:11:00 -05:00
'theme_supports' => 'custom-background' ,
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
)
)
);
2012-06-11 16:49:45 -04:00
2012-05-25 16:26:25 -04:00
$this -> add_control ( new WP_Customize_Background_Image_Control ( $this ) );
2012-03-22 04:07:44 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_preset' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-preset' ),
'theme_supports' => 'custom-background' ,
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
)
);
$this -> add_control (
2018-08-16 21:51:36 -04:00
'background_preset' ,
array (
2017-11-30 18:11:00 -05:00
'label' => _x ( 'Preset' , 'Background Preset' ),
'section' => 'background_image' ,
'type' => 'select' ,
'choices' => array (
'default' => _x ( 'Default' , 'Default Preset' ),
'fill' => __ ( 'Fill Screen' ),
'fit' => __ ( 'Fit to Screen' ),
'repeat' => _x ( 'Repeat' , 'Repeat Image' ),
'custom' => _x ( 'Custom' , 'Custom Preset' ),
),
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_position_x' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-position-x' ),
'theme_supports' => 'custom-background' ,
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_position_y' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-position-y' ),
'theme_supports' => 'custom-background' ,
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
)
);
$this -> add_control (
new WP_Customize_Background_Position_Control (
2018-08-16 21:51:36 -04:00
$this ,
'background_position' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Image Position' ),
'section' => 'background_image' ,
'settings' => array (
'x' => 'background_position_x' ,
'y' => 'background_position_y' ,
),
)
)
);
2012-03-22 04:07:44 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_size' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-size' ),
'theme_supports' => 'custom-background' ,
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
)
);
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_control (
2018-08-16 21:51:36 -04:00
'background_size' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Image Size' ),
'section' => 'background_image' ,
'type' => 'select' ,
'choices' => array (
2019-06-05 11:23:52 -04:00
'auto' => _x ( 'Original' , 'Original Size' ),
2017-11-30 18:11:00 -05:00
'contain' => __ ( 'Fit to Screen' ),
'cover' => __ ( 'Fill Screen' ),
),
)
);
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_repeat' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-repeat' ),
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
'theme_supports' => 'custom-background' ,
)
);
2012-03-28 00:14:09 -04:00
2017-11-30 18:11:00 -05:00
$this -> add_control (
2018-08-16 21:51:36 -04:00
'background_repeat' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Repeat Background Image' ),
'section' => 'background_image' ,
'type' => 'checkbox' ,
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'background_attachment' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_theme_support ( 'custom-background' , 'default-attachment' ),
'sanitize_callback' => array ( $this , '_sanitize_background_setting' ),
'theme_supports' => 'custom-background' ,
)
);
2012-02-24 23:12:43 -05:00
2017-11-30 18:11:00 -05:00
$this -> add_control (
2018-08-16 21:51:36 -04:00
'background_attachment' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Scroll with Page' ),
'section' => 'background_image' ,
'type' => 'checkbox' ,
)
);
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
2023-07-09 16:17:29 -04:00
/*
* If the theme is using the default background callback , we can update
* the background CSS using postMessage .
*/
2012-05-25 14:41:22 -04:00
if ( get_theme_support ( 'custom-background' , 'wp-head-callback' ) === '_custom_background_cb' ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
foreach ( array ( 'color' , 'image' , 'preset' , 'position_x' , 'position_y' , 'size' , 'repeat' , 'attachment' ) as $prop ) {
2012-05-25 14:41:22 -04:00
$this -> get_setting ( 'background_' . $prop ) -> transport = 'postMessage' ;
}
}
2016-09-19 20:47:30 -04:00
/*
* Static Front Page
2017-09-08 14:21:42 -04:00
* See also https :// core . trac . wordpress . org / ticket / 19627 which introduces the static - front - page theme_support .
2016-09-19 20:47:30 -04:00
* The following replicates behavior from options - reading . php .
*/
2015-01-18 01:01:24 -05:00
2017-11-30 18:11:00 -05:00
$this -> add_section (
2018-08-16 21:51:36 -04:00
'static_front_page' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'Homepage Settings' ),
'priority' => 120 ,
'description' => __ ( 'You can choose what’s displayed on the homepage of your site. It can be posts in reverse chronological order (classic blog), or a fixed/static page. To set a static homepage, you first need to create two Pages. One will become the homepage, and the other will be where your posts are displayed.' ),
'active_callback' => array ( $this , 'has_published_pages' ),
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'show_on_front' ,
array (
2017-11-30 18:11:00 -05:00
'default' => get_option ( 'show_on_front' ),
'capability' => 'manage_options' ,
'type' => 'option' ,
)
);
$this -> add_control (
2018-08-16 21:51:36 -04:00
'show_on_front' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Your homepage displays' ),
'section' => 'static_front_page' ,
'type' => 'radio' ,
'choices' => array (
'posts' => __ ( 'Your latest posts' ),
'page' => __ ( 'A static page' ),
),
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'page_on_front' ,
array (
2017-11-30 18:11:00 -05:00
'type' => 'option' ,
'capability' => 'manage_options' ,
)
);
$this -> add_control (
2018-08-16 21:51:36 -04:00
'page_on_front' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Homepage' ),
'section' => 'static_front_page' ,
'type' => 'dropdown-pages' ,
'allow_addition' => true ,
)
);
$this -> add_setting (
2018-08-16 21:51:36 -04:00
'page_for_posts' ,
array (
2017-11-30 18:11:00 -05:00
'type' => 'option' ,
'capability' => 'manage_options' ,
)
);
$this -> add_control (
2018-08-16 21:51:36 -04:00
'page_for_posts' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'Posts page' ),
'section' => 'static_front_page' ,
'type' => 'dropdown-pages' ,
'allow_addition' => true ,
)
);
2016-10-19 14:15:31 -04:00
/* Custom CSS */
2017-11-30 18:11:00 -05:00
$section_description = '<p>' ;
2017-09-24 12:00:46 -04:00
$section_description .= __ ( 'Add your own CSS code here to customize the appearance and layout of your site.' );
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 02:08:47 -04:00
$section_description .= sprintf (
2017-09-29 07:10:50 -04:00
' <a href="%1$s" class="external-link" target="_blank">%2$s<span class="screen-reader-text"> %3$s</span></a>' ,
2024-03-11 10:08:10 -04:00
esc_url ( __ ( 'https://developer.wordpress.org/advanced-administration/wordpress/css/' ) ),
2017-09-24 12:00:46 -04:00
__ ( 'Learn more about CSS' ),
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
/* translators: Hidden accessibility text. */
2018-05-05 05:45:22 -04:00
__ ( '(opens in a new tab)' )
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 02:08:47 -04:00
);
$section_description .= '</p>' ;
2017-09-24 12:00:46 -04:00
$section_description .= '<p id="editor-keyboard-trap-help-1">' . __ ( 'When using a keyboard to navigate:' ) . '</p>' ;
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 02:08:47 -04:00
$section_description .= '<ul>' ;
2017-09-24 12:00:46 -04:00
$section_description .= '<li id="editor-keyboard-trap-help-2">' . __ ( 'In the editing area, the Tab key enters a tab character.' ) . '</li>' ;
$section_description .= '<li id="editor-keyboard-trap-help-3">' . __ ( 'To move away from this area, press the Esc key followed by the Tab key.' ) . '</li>' ;
2019-05-23 21:18:53 -04:00
$section_description .= '<li id="editor-keyboard-trap-help-4">' . __ ( 'Screen reader users: when in forms mode, you may need to press the Esc key twice.' ) . '</li>' ;
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 02:08:47 -04:00
$section_description .= '</ul>' ;
if ( 'false' !== wp_get_current_user () -> syntax_highlighting ) {
$section_description .= '<p>' ;
$section_description .= sprintf (
2019-09-02 20:41:05 -04:00
/* translators: 1: Link to user profile, 2: Additional link attributes, 3: Accessibility text. */
2017-09-29 07:10:50 -04:00
__ ( 'The edit field automatically highlights code syntax. You can disable this in your <a href="%1$s" %2$s>user profile%3$s</a> to work in plain text mode.' ),
esc_url ( get_edit_profile_url () ),
'class="external-link" target="_blank"' ,
2017-11-30 18:11:00 -05:00
sprintf (
'<span class="screen-reader-text"> %s</span>' ,
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
/* translators: Hidden accessibility text. */
2018-05-05 05:45:22 -04:00
__ ( '(opens in a new tab)' )
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 02:08:47 -04:00
)
);
$section_description .= '</p>' ;
}
$section_description .= '<p class="section-description-buttons">' ;
2017-09-24 12:00:46 -04:00
$section_description .= '<button type="button" class="button-link section-description-close">' . __ ( 'Close' ) . '</button>' ;
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 02:08:47 -04:00
$section_description .= '</p>' ;
2017-11-30 18:11:00 -05:00
$this -> add_section (
2018-08-16 21:51:36 -04:00
'custom_css' ,
array (
2017-11-30 18:11:00 -05:00
'title' => __ ( 'Additional CSS' ),
'priority' => 200 ,
'description_hidden' => true ,
'description' => $section_description ,
)
);
$custom_css_setting = new WP_Customize_Custom_CSS_Setting (
2018-08-16 21:51:36 -04:00
$this ,
sprintf ( 'custom_css[%s]' , get_stylesheet () ),
array (
2017-11-30 18:11:00 -05:00
'capability' => 'edit_css' ,
'default' => '' ,
)
);
2016-10-19 14:15:31 -04:00
$this -> add_setting ( $custom_css_setting );
2017-11-30 18:11:00 -05:00
$this -> add_control (
new WP_Customize_Code_Editor_Control (
2018-08-16 21:51:36 -04:00
$this ,
'custom_css' ,
array (
2017-11-30 18:11:00 -05:00
'label' => __ ( 'CSS code' ),
'section' => 'custom_css' ,
'settings' => array ( 'default' => $custom_css_setting -> id ),
'code_type' => 'text/css' ,
'input_attrs' => array (
'aria-describedby' => 'editor-keyboard-trap-help-1 editor-keyboard-trap-help-2 editor-keyboard-trap-help-3 editor-keyboard-trap-help-4' ,
),
)
)
);
2016-09-19 20:47:30 -04:00
}
/**
2022-04-02 12:21:05 -04:00
* Returns whether there are published pages .
2016-09-19 20:47:30 -04:00
*
* Used as active callback for static front page section and controls .
*
* @ since 4.7 . 0
*
2019-12-06 17:23:04 -05:00
* @ return bool Whether there are published ( or to be published ) pages .
2016-09-19 20:47:30 -04:00
*/
public function has_published_pages () {
$setting = $this -> get_setting ( 'nav_menus_created_posts' );
if ( $setting ) {
foreach ( $setting -> value () as $post_id ) {
if ( 'page' === get_post_type ( $post_id ) ) {
return true ;
}
}
2015-01-18 01:01:24 -05:00
}
2022-12-05 16:31:11 -05:00
return 0 !== count (
get_pages (
array (
'number' => 1 ,
'hierarchical' => 0 ,
)
)
);
2012-02-24 23:12:43 -05:00
}
2012-05-23 11:36:27 -04:00
2015-02-08 18:11:25 -05:00
/**
2022-04-02 12:21:05 -04:00
* Adds settings from the POST data that were not added with code , e . g . dynamically - created settings for Widgets
2015-02-08 18:11:25 -05:00
*
* @ since 4.2 . 0
2015-04-05 11:07:27 -04:00
*
* @ see add_dynamic_settings ()
2015-02-08 18:11:25 -05:00
*/
public function register_dynamic_settings () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$setting_ids = array_keys ( $this -> unsanitized_post_values () );
$this -> add_dynamic_settings ( $setting_ids );
2015-02-08 18:11:25 -05:00
}
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
/**
2022-04-02 12:21:05 -04:00
* Loads themes into the theme browsing / installation UI .
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
*
* @ since 4.9 . 0
*/
2017-10-01 23:37:46 -04:00
public function handle_load_themes_request () {
check_ajax_referer ( 'switch_themes' , 'nonce' );
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
if ( ! current_user_can ( 'switch_themes' ) ) {
wp_die ( - 1 );
}
if ( empty ( $_POST [ 'theme_action' ] ) ) {
wp_send_json_error ( 'missing_theme_action' );
}
$theme_action = sanitize_key ( $_POST [ 'theme_action' ] );
2017-11-30 18:11:00 -05:00
$themes = array ();
$args = array ();
2017-10-10 03:09:52 -04:00
// Define query filters based on user input.
if ( ! array_key_exists ( 'search' , $_POST ) ) {
$args [ 'search' ] = '' ;
} else {
$args [ 'search' ] = sanitize_text_field ( wp_unslash ( $_POST [ 'search' ] ) );
}
if ( ! array_key_exists ( 'tags' , $_POST ) ) {
$args [ 'tag' ] = '' ;
} else {
$args [ 'tag' ] = array_map ( 'sanitize_text_field' , wp_unslash ( ( array ) $_POST [ 'tags' ] ) );
}
if ( ! array_key_exists ( 'page' , $_POST ) ) {
$args [ 'page' ] = 1 ;
} else {
$args [ 'page' ] = absint ( $_POST [ 'page' ] );
}
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
require_once ABSPATH . 'wp-admin/includes/theme.php' ;
2017-10-10 03:09:52 -04:00
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
if ( 'installed' === $theme_action ) {
2017-10-10 03:09:52 -04:00
// Load all installed themes from wp_prepare_themes_for_js().
Customize: Overlay incompatible banner for block themes.
Starting in 5.9, block themes are not compatible with (do not support) Customizer; rather, they use the Site Editor. Viewing installed themes in Customizer, this commit adds an overlay message to alert users and give them a way to activate the block theme. Clicking on the "Activate" button activates the block theme and redirects back to the Appearance > Themes interface, where the user can then enter the Site Editor for customization.
Non-block themes are not affected by this change and continue to work in Customizer.
Follow-up to [41648], [41893], [52279].
Props antonvlasenko, costdev, hellofromTonya, jffng, joyously, noisysocks, poena, shaunandrews.
Fixes #54549.
Built from https://develop.svn.wordpress.org/trunk@52371
git-svn-id: http://core.svn.wordpress.org/trunk@51963 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-12-14 10:33:01 -05:00
$themes = array ( 'themes' => array () );
foreach ( wp_prepare_themes_for_js () as $theme ) {
$theme [ 'type' ] = 'installed' ;
$theme [ 'active' ] = ( isset ( $_POST [ 'customized_theme' ] ) && $_POST [ 'customized_theme' ] === $theme [ 'id' ] );
$themes [ 'themes' ][] = $theme ;
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
}
} elseif ( 'wporg' === $theme_action ) {
2017-10-10 03:09:52 -04:00
// Load WordPress.org themes from the .org API and normalize data to match installed theme objects.
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
if ( ! current_user_can ( 'install_themes' ) ) {
wp_die ( - 1 );
}
// Arguments for all queries.
2017-10-10 03:09:52 -04:00
$wporg_args = array (
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
'per_page' => 100 ,
2019-03-21 18:02:51 -04:00
'fields' => array (
'reviews_url' => true , // Explicitly request the reviews URL to be linked from the customizer.
),
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
);
2017-10-10 03:09:52 -04:00
$args = array_merge ( $wporg_args , $args );
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
if ( '' === $args [ 'search' ] && '' === $args [ 'tag' ] ) {
$args [ 'browse' ] = 'new' ; // Sort by latest themes by default.
}
// Load themes from the .org API.
$themes = themes_api ( 'query_themes' , $args );
if ( is_wp_error ( $themes ) ) {
wp_send_json_error ();
}
// This list matches the allowed tags in wp-admin/includes/theme-install.php.
2017-11-30 18:11:00 -05:00
$themes_allowedtags = array_fill_keys (
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
array ( 'a' , 'abbr' , 'acronym' , 'code' , 'pre' , 'em' , 'strong' , 'div' , 'p' , 'ul' , 'ol' , 'li' , 'h1' , 'h2' , 'h3' , 'h4' , 'h5' , 'h6' , 'img' ),
array ()
);
2017-11-30 18:11:00 -05:00
$themes_allowedtags [ 'a' ] = array_fill_keys ( array ( 'href' , 'title' , 'target' ), true );
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
$themes_allowedtags [ 'acronym' ][ 'title' ] = true ;
2017-11-30 18:11:00 -05:00
$themes_allowedtags [ 'abbr' ][ 'title' ] = true ;
$themes_allowedtags [ 'img' ] = array_fill_keys ( array ( 'src' , 'class' , 'alt' ), true );
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
// Prepare a list of installed themes to check against before the loop.
$installed_themes = array ();
2017-11-30 18:11:00 -05:00
$wp_themes = wp_get_themes ();
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
foreach ( $wp_themes as $theme ) {
$installed_themes [] = $theme -> get_stylesheet ();
}
$update_php = network_admin_url ( 'update.php?action=install-theme' );
// Set up properties for themes available on WordPress.org.
foreach ( $themes -> themes as & $theme ) {
2017-11-30 18:11:00 -05:00
$theme -> install_url = add_query_arg (
array (
'theme' => $theme -> slug ,
'_wpnonce' => wp_create_nonce ( 'install-theme_' . $theme -> slug ),
2018-08-16 21:51:36 -04:00
),
$update_php
2017-11-30 18:11:00 -05:00
);
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
$theme -> name = wp_kses ( $theme -> name , $themes_allowedtags );
$theme -> version = wp_kses ( $theme -> version , $themes_allowedtags );
$theme -> description = wp_kses ( $theme -> description , $themes_allowedtags );
2017-11-30 18:11:00 -05:00
$theme -> stars = wp_star_rating (
array (
'rating' => $theme -> rating ,
'type' => 'percent' ,
'number' => $theme -> num_ratings ,
'echo' => false ,
)
);
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
$theme -> num_ratings = number_format_i18n ( $theme -> num_ratings );
$theme -> preview_url = set_url_scheme ( $theme -> preview_url );
// Handle themes that are already installed as installed themes.
if ( in_array ( $theme -> slug , $installed_themes , true ) ) {
$theme -> type = 'installed' ;
} else {
$theme -> type = $theme_action ;
}
// Set active based on customized theme.
$theme -> active = ( isset ( $_POST [ 'customized_theme' ] ) && $_POST [ 'customized_theme' ] === $theme -> slug );
// Map available theme properties to installed theme properties.
2020-05-18 12:03:09 -04:00
$theme -> id = $theme -> slug ;
$theme -> screenshot = array ( $theme -> screenshot_url );
$theme -> authorAndUri = wp_kses ( $theme -> author [ 'display_name' ], $themes_allowedtags );
2020-05-19 04:41:12 -04:00
$theme -> compatibleWP = is_wp_version_compatible ( $theme -> requires ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName
$theme -> compatiblePHP = is_php_version_compatible ( $theme -> requires_php ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName
2018-02-01 00:19:30 -05:00
2017-11-06 23:17:47 -05:00
if ( isset ( $theme -> parent ) ) {
$theme -> parent = $theme -> parent [ 'slug' ];
} else {
$theme -> parent = false ;
}
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
unset ( $theme -> slug );
unset ( $theme -> screenshot_url );
unset ( $theme -> author );
} // End foreach().
} // End if().
2017-10-10 03:09:52 -04:00
/**
* Filters the theme data loaded in the customizer .
*
* This allows theme data to be loading from an external source ,
* or modification of data loaded from `wp_prepare_themes_for_js()`
* or WordPress . org via `themes_api()` .
*
* @ since 4.9 . 0
*
* @ see wp_prepare_themes_for_js ()
* @ see themes_api ()
* @ see WP_Customize_Manager :: __construct ()
*
2021-11-18 08:50:05 -05:00
* @ param array | stdClass $themes Nested array or object of theme data .
2017-10-10 03:09:52 -04:00
* @ param array $args List of arguments , such as page , search term , and tags to query for .
* @ param WP_Customize_Manager $manager Instance of Customize manager .
*/
$themes = apply_filters ( 'customize_load_themes' , $themes , $args , $this );
Customize: Introduce a new experience for discovering, installing, and previewing themes within the customizer.
Unify the theme-browsing and theme-customization experiences by introducing a comprehensive theme browser and installer directly accessible in the customizer. Replaces the customizer theme switcher with a full-screen panel for discovering/browsing and installing themes available on WordPress.org. Themes can now be installed and previewed directly in the customizer without entering the wp-admin context. Also includes an extensible framework for browsing and installing themes from other sources.
Also includes CSS auto-prefixing added via `grunt precommit:css`.
For details, see: https://make.wordpress.org/core/2016/10/03/feature-proposal-a-new-experience-for-discovering-installing-and-previewing-themes-in-the-customizer/
Previously [38813] but reverted in [39140].
Fixes #37661, #34843, #38666.
Props celloexpressions, folletto, westonruter, karmatosed, melchoyce, afercia.
Built from https://develop.svn.wordpress.org/trunk@41648
git-svn-id: http://core.svn.wordpress.org/trunk@41482 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-29 16:13:50 -04:00
wp_send_json_success ( $themes );
}
2012-05-26 14:44:31 -04:00
/**
* Callback for validating the header_textcolor value .
*
* Accepts 'blank' , and otherwise uses sanitize_hex_color_no_hash () .
2013-07-12 16:41:46 -04:00
* Returns default text color if hex color is empty .
2012-05-26 14:44:31 -04:00
*
* @ since 3.4 . 0
2012-07-26 17:45:33 -04:00
*
* @ param string $color
2015-05-21 18:05:24 -04:00
* @ return mixed
2012-05-26 14:44:31 -04:00
*/
public function _sanitize_header_textcolor ( $color ) {
2017-11-30 18:11:00 -05:00
if ( 'blank' === $color ) {
2013-07-12 16:41:46 -04:00
return 'blank' ;
2017-11-30 18:11:00 -05:00
}
2013-07-12 16:41:46 -04:00
$color = sanitize_hex_color_no_hash ( $color );
2017-11-30 18:11:00 -05:00
if ( empty ( $color ) ) {
2013-07-12 16:41:46 -04:00
$color = get_theme_support ( 'custom-header' , 'default-text-color' );
2017-11-30 18:11:00 -05:00
}
2013-07-12 16:41:46 -04:00
return $color ;
2012-05-26 14:44:31 -04:00
}
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
/**
* Callback for validating a background setting value .
*
* @ since 4.7 . 0
*
2020-07-23 17:11:05 -04:00
* @ param string $value Repeat value .
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
* @ param WP_Customize_Setting $setting Setting .
* @ return string | WP_Error Background value or validation error .
*/
public function _sanitize_background_setting ( $value , $setting ) {
if ( 'background_repeat' === $setting -> id ) {
2020-04-04 23:02:11 -04:00
if ( ! in_array ( $value , array ( 'repeat-x' , 'repeat-y' , 'repeat' , 'no-repeat' ), true ) ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
return new WP_Error ( 'invalid_value' , __ ( 'Invalid value for background repeat.' ) );
}
2016-11-23 01:05:32 -05:00
} elseif ( 'background_attachment' === $setting -> id ) {
2020-04-04 23:02:11 -04:00
if ( ! in_array ( $value , array ( 'fixed' , 'scroll' ), true ) ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
return new WP_Error ( 'invalid_value' , __ ( 'Invalid value for background attachment.' ) );
}
2016-11-23 01:05:32 -05:00
} elseif ( 'background_position_x' === $setting -> id ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
if ( ! in_array ( $value , array ( 'left' , 'center' , 'right' ), true ) ) {
return new WP_Error ( 'invalid_value' , __ ( 'Invalid value for background position X.' ) );
}
2016-11-23 01:05:32 -05:00
} elseif ( 'background_position_y' === $setting -> id ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
if ( ! in_array ( $value , array ( 'top' , 'center' , 'bottom' ), true ) ) {
return new WP_Error ( 'invalid_value' , __ ( 'Invalid value for background position Y.' ) );
}
2016-11-23 01:05:32 -05:00
} elseif ( 'background_size' === $setting -> id ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
if ( ! in_array ( $value , array ( 'auto' , 'contain' , 'cover' ), true ) ) {
return new WP_Error ( 'invalid_value' , __ ( 'Invalid value for background size.' ) );
}
2016-11-23 01:05:32 -05:00
} elseif ( 'background_preset' === $setting -> id ) {
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
if ( ! in_array ( $value , array ( 'default' , 'fill' , 'fit' , 'repeat' , 'custom' ), true ) ) {
return new WP_Error ( 'invalid_value' , __ ( 'Invalid value for background size.' ) );
}
2016-11-23 01:05:32 -05:00
} elseif ( 'background_image' === $setting -> id || 'background_image_thumb' === $setting -> id ) {
2022-06-01 14:14:10 -04:00
$value = empty ( $value ) ? '' : sanitize_url ( $value );
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
} else {
return new WP_Error ( 'unrecognized_setting' , __ ( 'Unrecognized background setting.' ) );
}
return $value ;
}
2016-10-27 17:51:31 -04:00
/**
2022-04-02 12:21:05 -04:00
* Exports header video settings to facilitate selective refresh .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*
2020-07-23 17:11:05 -04:00
* @ param array $response Response .
2016-10-27 17:51:31 -04:00
* @ param WP_Customize_Selective_Refresh $selective_refresh Selective refresh component .
2020-07-23 17:11:05 -04:00
* @ param array $partials Array of partials .
2016-10-27 17:51:31 -04:00
* @ return array
*/
public function export_header_video_settings ( $response , $selective_refresh , $partials ) {
2016-10-27 21:51:31 -04:00
if ( isset ( $partials [ 'custom_header' ] ) ) {
2016-10-27 17:51:31 -04:00
$response [ 'custom_header_settings' ] = get_header_video_settings ();
}
return $response ;
}
/**
* Callback for validating the header_video value .
*
* Ensures that the selected video is less than 8 MB and provides an error message .
*
* @ since 4.7 . 0
*
* @ param WP_Error $validity
2020-07-23 16:01:04 -04:00
* @ param mixed $value
2016-10-27 17:51:31 -04:00
* @ return mixed
*/
public function _validate_header_video ( $validity , $value ) {
$video = get_attached_file ( absint ( $value ) );
if ( $video ) {
$size = filesize ( $video );
2019-09-21 08:49:57 -04:00
if ( $size > 8 * MB_IN_BYTES ) {
2017-11-30 18:11:00 -05:00
$validity -> add (
'size_too_large' ,
2016-11-15 15:54:30 -05:00
__ ( 'This video file is too large to use as a header video. Try a shorter video or optimize the compression settings and re-upload a file that is less than 8MB. Or, upload your video to YouTube and link it with the option below.' )
);
2016-10-27 17:51:31 -04:00
}
Code Modernization: Replace usage of `substr()` with `str_starts_with()` and `str_ends_with()`.
`str_starts_with()` and `str_ends_with()` were introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins or ends with the given substring (needle).
WordPress core includes a polyfill for these functions on PHP < 8.0 as of WordPress 5.9.
This commit uses `str_starts_with()` and `str_ends_with()` in core files where appropriate:
* `$needle === substr( $string, 0, $length )`, where `$length` is the length of `$needle`, is replaced with `str_starts_with( $haystack, $needle )`.
* `$needle === substr( $string, $offset )`, where `$offset` is negative and the absolute value of `$offset` is the length of `$needle`, is replaced with `str_ends_with( $haystack, $needle )`.
This aims to make the code more readable and consistent, as well as better aligned with modern development practices.
Follow-up to [52039], [52040], [52326], [55703], [55710], [55987], [55988].
Props Soean, spacedmonkey, Clorith, ocean90, azaozz, sabernhardt, SergeyBiryukov.
Fixes #58220.
Built from https://develop.svn.wordpress.org/trunk@55990
git-svn-id: http://core.svn.wordpress.org/trunk@55502 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-06-22 10:57:24 -04:00
if ( ! str_ends_with ( $video , '.mp4' ) && ! str_ends_with ( $video , '.mov' ) ) { // Check for .mp4 or .mov format, which (assuming h.264 encoding) are the only cross-browser-supported formats.
2017-11-30 18:11:00 -05:00
$validity -> add (
2018-08-16 21:51:36 -04:00
'invalid_file_type' ,
sprintf (
2017-11-30 18:11:00 -05:00
/* translators: 1: .mp4, 2: .mov */
__ ( 'Only %1$s or %2$s files may be used for header video. Please convert your video file and try again, or, upload your video to YouTube and link it with the option below.' ),
'<code>.mp4</code>' ,
'<code>.mov</code>'
)
);
2016-10-27 17:51:31 -04:00
}
}
return $validity ;
}
/**
* Callback for validating the external_header_video value .
*
2016-11-08 14:20:32 -05:00
* Ensures that the provided URL is supported .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*
* @ param WP_Error $validity
2020-07-23 16:01:04 -04:00
* @ param mixed $value
2016-10-27 17:51:31 -04:00
* @ return mixed
*/
public function _validate_external_header_video ( $validity , $value ) {
2022-06-01 14:14:10 -04:00
$video = sanitize_url ( $value );
2016-10-27 17:51:31 -04:00
if ( $video ) {
2016-11-05 14:32:35 -04:00
if ( ! preg_match ( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#' , $video ) ) {
$validity -> add ( 'invalid_url' , __ ( 'Please enter a valid YouTube URL.' ) );
2016-10-27 17:51:31 -04:00
}
}
return $validity ;
}
2016-12-10 02:00:45 -05:00
/**
* Callback for sanitizing the external_header_video value .
*
* @ since 4.7 . 1
*
* @ param string $value URL .
* @ return string Sanitized URL .
*/
public function _sanitize_external_header_video ( $value ) {
2022-06-01 14:14:10 -04:00
return sanitize_url ( trim ( $value ) );
2016-12-10 02:00:45 -05:00
}
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
/**
2016-03-03 14:56:26 -05:00
* Callback for rendering the custom logo , used in the custom_logo partial .
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
*
* This method exists because the partial object and context data are passed
2016-03-03 14:56:26 -05:00
* into a partial ' s render_callback so we cannot use get_custom_logo () as
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
* the render_callback directly since it expects a blog ID as the first
* argument . When WP no longer supports PHP 5.3 , this method can be removed
* in favor of an anonymous function .
*
* @ see WP_Customize_Manager :: register_controls ()
*
* @ since 4.5 . 0
*
2016-03-03 14:56:26 -05:00
* @ return string Custom logo .
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
*/
2016-03-03 14:56:26 -05:00
public function _render_custom_logo_partial () {
return get_custom_logo ();
Customize: Introduce Logo support for themes.
Allows a common theme feature to have a common implementation provided by core and available in a consistent location for users.
See https://make.wordpress.org/core/2016/02/24/theme-logo-support/
Props kwight, enejb, jeherve, bhubbard, samhotchkiss, zinigor, eliorivero, adamsilverstein, melchoyce, ryan, mikeschroder, westonruter, pento, karmatosed, celloexpressions, obenland.
See #33755.
Built from https://develop.svn.wordpress.org/trunk@36698
git-svn-id: http://core.svn.wordpress.org/trunk@36665 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-02-24 17:10:26 -05:00
}
2014-05-22 15:01:15 -04:00
}