An open API service indexing awesome lists of open source software.

https://github.com/xwp/wp-customize-partial-refresh

[OBSOLETE: Now part of Core] Customize Partial Refresh plugin for WordPress
https://github.com/xwp/wp-customize-partial-refresh

Last synced: 9 months ago
JSON representation

[OBSOLETE: Now part of Core] Customize Partial Refresh plugin for WordPress

Awesome Lists containing this project

README

          

# Customize Partial Refresh

Refresh parts of the Customizer preview instead of reloading the entire page.

**Contributors:** [xwp](https://profiles.wordpress.org/xwp), [westonruter](https://profiles.wordpress.org/westonruter), [valendesigns](https://profiles.wordpress.org/valendesigns)
**Tags:** [customizer](https://wordpress.org/plugins/tags/customizer), [customize](https://wordpress.org/plugins/tags/customize), [preview](https://wordpress.org/plugins/tags/preview)
**Requires at least:** 4.5-alpha-35776
**Stable tag:** trunk (master)
**License:** [GPLv2 or later](http://www.gnu.org/licenses/gpl-2.0.html)

[![Build Status](https://travis-ci.org/xwp/wp-customize-partial-refresh.svg?branch=master)](https://travis-ci.org/xwp/wp-customize-partial-refresh)

## Description ##

This is a feature plugin for WordPress 4.5

Please read the Make Core post: [Selective Refresh in the Customizer](https://make.wordpress.org/core/2016/02/16/selective-refresh-in-the-customizer/).

Development of this plugin is done [on GitHub](https://github.com/xwp/wp-customize-partial-refresh). Pull requests welcome. Please see [issues](https://github.com/xwp/wp-customize-partial-refresh/issues) reported there before going to the [plugin forum](https://wordpress.org/support/plugin/customize-partial-refresh).

## Changelog ##

### 0.6.2 ###
* Short-circuit plugin if Selective Refresh feature has been merged into core. See [#27355](https://core.trac.wordpress.org/ticket/27355).
* Add more unit tests.

### 0.6.1 ###
Fix Jetpack plugin support to use new `container` event property.

### 0.6.0 ###
* Introduce formalized `Placement` JS construct.
* Add `sidebar-updated` event.
* Add support for Twenty Thirteen theme's Masonry-built sidebar.
* Update JS namespace to `wp.customize.selectiveRefresh`, with JS objects and events using this as root.
* Rename `WidgetInstance` to `Widget` and `WidgetArea` to `Sidebar`.
* Flesh out more PHPUnit tests and add foundations for QUnit tests.
* Always include the `data-customize-partial-id` attr selector
* See all changes: [0.5.4...0.6.0](https://github.com/xwp/wp-customize-partial-refresh/compare/0.5.4...0.6.0)

### 0.5.4 ###
* Trigger `partial-content-rendered` on nested partials' containers when parent is refreshed.
* Jetpack: Restrict adding partials to infinity scroll container on `post-load`.

### 0.5.3 ###
* Capture errors triggered during partial rendering, preventing them from displaying inline which can cause the containers to be corrupted and break subsequent updates. If `WP_DEBUG_DISPLAY` is enabled, the errors will be added to the console as warnings.
* Also add initial support for Jetpack's Facebook Page widget.

### 0.5.2 ###
* Fix position of widget in sidebar if a `widget_instance` partial container is inserted prior to an refresh.
* Only sort the DOM if the order has changed, to improve performance.
* Introduce `getWidgetIds` and `reflowWidgets` methods for widget area partial.
* Introduce `partial-content-moved` event when a widget is re-ordered.
* Add support for Jetpack's Twitter Timeline and Contact Info widgets.

### 0.5.1 ###
* Fix broken Ajax in preview by adding missing script dependency for wp-util.
* Add support for plugin loaded via theme (on WordPress.com).
* Ensure that dynamic_sidebar_params filter applies during partials render request.
* Remove unnecessary is_registered_sidebar() which broke nested sidebar stack

### 0.5.0 ###
Complete rewrite utilizing new selective/partial refresh framework. Selective refreshing of nav menus (in core) and widgets (in this plugin) were rewritten to make use of the new framework. Documentation forthcoming.

### 0.4.3 ###
* Fix PHP 5.2 compatibility.
* Fix support for subdirectory installs.

### 0.4.2 ###
* Fix typo causing twentyten, twentyeleven, and twentytwelve not being enabled for widget partial refresh.

### 0.4.1 ###
* Remove partial refresh functionality since it is now moved over to Menu Customizer directly.

### 0.4 ###
* Add integration for Menu Customizer.
* See all changes: [0.3...0.4](https://github.com/xwp/wp-customize-partial-refresh/compare/0.3...0.4)

### 0.3 ###
* Use trigger_error instead of error_log; do nothing on WPCOM
* Introduce widgetsExcludedForPostMessage stop gap
* Communicate to pane all widgets rendered, not just main one
* See all changes: [0.2...0.3](https://github.com/xwp/wp-customize-partial-refresh/compare/0.2...0.3)

### 0.2 ###
* Fix partial refresh during theme preview ([PR #9](https://github.com/xwp/wp-customize-partial-refresh/pull/9))
* Eliminate remaining direct calls to parent window, use `postMessage` only ([PR #8](https://github.com/xwp/wp-customize-partial-refresh/pull/8))
* Allow inactive widgets to be rendered if sidebar is specified ([PR #10](https://github.com/xwp/wp-customize-partial-refresh/pull/10))
* Add initial support for plugins to support custom sidebars
* Various other fixes and hardening, see [0.1...0.2](https://github.com/xwp/wp-customize-partial-refresh/compare/0.1...0.2).

### 0.1 ###
* Resurrect Widget Customizer partial refreshes.