customize_render_partials_response

Advertisement

Summery Summery

Filters the response from rendering the partials.

Syntax Syntax

apply_filters( 'customize_render_partials_response', array $response, WP_Customize_Selective_Refresh $this, array $partials )

Description Description

Plugins may use this filter to inject $scripts and $styles, which are dependencies for the partials being rendered. The response data will be available to the client via the render-partials-response JS event, so the client can then inject the scripts and styles into the DOM if they have not already been enqueued there.

If plugins do this, they’ll need to take care for any scripts that do document.write() and make sure that these are not injected, or else to override the function to no-op, or else the page will be destroyed.

Plugins should be aware that $scripts and $styles may eventually be included by default in the response.

Parameters Parameters

$response

(array) Response.

  • 'contents'
    (array) Associative array mapping a partial ID its corresponding array of contents for the containers requested.
  • 'errors'
    (array) List of errors triggered during rendering of partials, if WP_DEBUG_DISPLAY is enabled.

$this

(WP_Customize_Selective_Refresh) Selective refresh component.

$partials

(array) Placements' context data for the partials rendered in the request. The array is keyed by partial ID, with each item being an array of the placements' context data.

Source Source

File: wp-includes/customize/class-wp-customize-selective-refresh.php

Advertisement

Changelog Changelog

Changelog
Version Description
4.5.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.