Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Block bindings: Adds a filter to customize the output of a block bindings source. #6839

Closed
wants to merge 20 commits into from
Closed

Block bindings: Adds a filter to customize the output of a block bindings source. #6839

Changes from 7 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
3e636cd
feat: Add filter to customize output of _block_bindings_post_meta_get…
snehapatil2001 Jun 17, 2024
fb9c797
Merge branch 'trunk' into feature/add-post-meta-value-filter
snehapatil2001 Jul 1, 2024
f882729
feat: the filter is applied after the value is retrieved from the sou…
snehapatil2001 Jul 1, 2024
ae25e24
fix: phpcs errors.
snehapatil2001 Jul 1, 2024
b5cfd83
Merge branch 'trunk' into feature/add-post-meta-value-filter
snehapatil2001 Jul 2, 2024
c4d9b86
Restore since
cbravobernal Sep 2, 2024
c360541
Add filter docs
cbravobernal Sep 3, 2024
7edc027
Add unit test for filter
cbravobernal Sep 3, 2024
95798f4
Adapt docs
cbravobernal Sep 3, 2024
e7e56af
Apply format
cbravobernal Sep 3, 2024
093245d
Edit description
cbravobernal Sep 3, 2024
05d2dc1
Remove extra spaces
cbravobernal Sep 3, 2024
4979c9d
More format
cbravobernal Sep 3, 2024
0a8b762
Refactor test to include all args
cbravobernal Sep 3, 2024
6edcc15
Add test on render
cbravobernal Sep 3, 2024
c112469
Remove not needed args
cbravobernal Sep 3, 2024
f1223ee
Update test message
cbravobernal Sep 3, 2024
1e5d633
Some spacing
cbravobernal Sep 3, 2024
5af69a6
Add 5 vars
cbravobernal Sep 3, 2024
e52dbc2
Save some bytes by returning empty string
cbravobernal Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions src/wp-includes/class-wp-block-bindings-source.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
/**
* Block Bindings API: WP_Block_Bindings_Source class.
*
*
* @package WordPress
* @subpackage Block Bindings
* @since 6.5.0
Expand Down Expand Up @@ -75,14 +74,25 @@ public function __construct( string $name, array $source_properties ) {
*
* @since 6.5.0
cbravobernal marked this conversation as resolved.
Show resolved Hide resolved
cbravobernal marked this conversation as resolved.
Show resolved Hide resolved
*
* This function calls the callback function specified in the `$get_value_callback` property
* with the given arguments and returns the result. It then applies the filter
* `block_bindings_source_value` to the value before returning it.
*
* @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.
*
* @return mixed The value of the source.
*/
public function get_value( array $source_args, $block_instance, string $attribute_name ) {
return 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 Value returned by `get_value_callback` after applying the filter.
*/
$value = call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
return apply_filters( 'block_bindings_source_value', $value, $this->name, $source_args, $block_instance, $attribute_name );
gziolo marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It still needs some further refinements, so it gets correctly recognized by the parser that generates the documentation for all filters:

Suggested change
/**
* Filters the output of a block bindings source.
*
* @since 6.7.0
*
* @param mixed $value Value returned by `get_value_callback` after applying the filter.
*/
$value = call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
return apply_filters( 'block_bindings_source_value', $value, $this->name, $source_args, $block_instance, $attribute_name );
$value = call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
/**
* Filters the value 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 );

}

/**
Expand Down
Loading