<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58972] trunk: Block bindings: Adds a filter to customize the output of a block bindings source.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58972">58972</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58972","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>cbravobernal</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-03 16:31:44 +0000 (Tue, 03 Sep 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Block bindings: Adds a filter to customize the output of a block bindings source.
Introduces a filter to the `block_bindings_source_value` to allow developers to
modify the value returned by any block binding source.
Props snehapatil02, cbravobernal, gziolo, santosguillamot, bacoords, codersantosh.
Fixes <a href="https://core.trac.wordpress.org/ticket/61181">#61181</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpblockbindingssourcephp">trunk/src/wp-includes/class-wp-block-bindings-source.php</a></li>
<li><a href="#trunktestsphpunittestsblockbindingspostMetaSourcephp">trunk/tests/phpunit/tests/block-bindings/postMetaSource.php</a></li>
<li><a href="#trunktestsphpunittestsblockbindingsrenderphp">trunk/tests/phpunit/tests/block-bindings/render.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpblockbindingssourcephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-block-bindings-source.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-bindings-source.php 2024-09-03 16:25:16 UTC (rev 58971)
+++ trunk/src/wp-includes/class-wp-block-bindings-source.php 2024-09-03 16:31:44 UTC (rev 58972)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,7 +2,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Block Bindings API: WP_Block_Bindings_Source class.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @package WordPress
</span><span class="cx" style="display: block; padding: 0 10px"> * @subpackage Block Bindings
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,8 +59,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name The name of the source.
- * @param array $source_properties The properties of the source.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $name The name of the source.
+ * @param array $source_properties The properties of the source.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( string $name, array $source_properties ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->name = $name;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,18 +70,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieves the value from the source.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls the callback function specified in the `$get_value_callback` property
+ * with the given arguments and returns the result. It can be modified with
+ * `block_bindings_source_value` filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.7.0 `block_bindings_source_value` filter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $source_args Array containing source arguments used to look up the override value, i.e. {"key": "foo"}.
- * @param WP_Block $block_instance The block instance.
- * @param string $attribute_name The name of the target attribute.
- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $source_args Array containing source arguments used to look up the override value, i.e. {"key": "foo"}.
+ * @param WP_Block $block_instance The block instance.
+ * @param string $attribute_name The name of the target attribute.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed The value of the source.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_value( array $source_args, $block_instance, string $attribute_name ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
+ /**
+ * Filters the output of a block bindings source.
+ *
+ * @since 6.7.0
+ *
+ * @param mixed $value The computed value for the source.
+ * @param string $name The name of the source.
+ * @param array $source_args Array containing source arguments used to look up the override value, i.e. { "key": "foo" }.
+ * @param WP_Block $block_instance The block instance.
+ * @param string $attribute_name The name of an attribute.
+ */
+ return apply_filters( 'block_bindings_source_value', $value, $this->name, $source_args, $block_instance, $attribute_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsblockbindingspostMetaSourcephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/block-bindings/postMetaSource.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-bindings/postMetaSource.php 2024-09-03 16:25:16 UTC (rev 58971)
+++ trunk/tests/phpunit/tests/block-bindings/postMetaSource.php 2024-09-03 16:31:44 UTC (rev 58972)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -266,4 +266,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'The post content should not include the script tag.'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that filter `block_bindings_source_value` is applied.
+ *
+ * @ticket 61181
+ */
+ public function test_filter_block_bindings_source_value() {
+ register_meta(
+ 'post',
+ 'tests_filter_field',
+ array(
+ 'show_in_rest' => true,
+ 'single' => true,
+ 'type' => 'string',
+ 'default' => 'Original value',
+ )
+ );
+
+ $filter_value = function ( $value, $source_name, $source_args ) {
+ if ( 'core/post-meta' !== $source_name ) {
+ return $value;
+ }
+ return "Filtered value: {$source_args['key']}";
+ };
+
+ add_filter( 'block_bindings_source_value', $filter_value, 10, 3 );
+
+ $content = $this->get_modified_post_content( '<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"core/post-meta","args":{"key":"tests_filter_field"}}}}} --><p>Fallback value</p><!-- /wp:paragraph -->' );
+
+ remove_filter( 'block_bindings_source_value', $filter_value );
+
+ $this->assertSame(
+ '<p>Filtered value: tests_filter_field</p>',
+ $content,
+ 'The post content should show the filtered value.'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsblockbindingsrenderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/block-bindings/render.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-bindings/render.php 2024-09-03 16:25:16 UTC (rev 58971)
+++ trunk/tests/phpunit/tests/block-bindings/render.php 2024-09-03 16:31:44 UTC (rev 58972)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -298,4 +298,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'The `__default` attribute should be replaced with the real attribute prior to the callback.'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that filter `block_bindings_source_value` is applied.
+ *
+ * @ticket 61181
+ */
+ public function test_filter_block_bindings_source_value() {
+ register_block_bindings_source(
+ self::SOURCE_NAME,
+ array(
+ 'label' => self::SOURCE_LABEL,
+ 'get_value_callback' => function () {
+ return '';
+ },
+ )
+ );
+
+ $filter_value = function ( $value, $source_name, $source_args, $block_instance, $attribute_name ) {
+ if ( self::SOURCE_NAME !== $source_name ) {
+ return $value;
+ }
+ return "Filtered value: {$source_args['test_key']}. Block instance: {$block_instance->name}. Attribute name: {$attribute_name}.";
+ };
+
+ add_filter( 'block_bindings_source_value', $filter_value, 10, 5 );
+
+ $block_content = <<<HTML
+<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"test/source", "args":{"test_key":"test_arg"}}}}} -->
+<p>Default content</p>
+<!-- /wp:paragraph -->
+HTML;
+ $parsed_blocks = parse_blocks( $block_content );
+ $block = new WP_Block( $parsed_blocks[0] );
+ $result = $block->render();
+
+ remove_filter( 'block_bindings_source_value', $filter_value );
+
+ $this->assertSame(
+ '<p>Filtered value: test_arg. Block instance: core/paragraph. Attribute name: content.</p>',
+ trim( $result ),
+ 'The block content should show the filtered value.'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>