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.

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

Update block-filters.md #64959

Merged
merged 11 commits into from
Oct 1, 2024
Merged

Update block-filters.md #64959

merged 11 commits into from
Oct 1, 2024

Conversation

davy440
Copy link
Contributor

@davy440 davy440 commented Aug 31, 2024

What?

Describing the blocks.getBlockAttributes filter

Why?

The documentation needed updation regarding the filter. It could be helpful exploring further applications of the filter hook.

How?

Currently, there is no documentation for the filter hook.

Testing Instructions

  1. Set up the block development environment using @wordpress/scripts package.
  2. Setup an entry-point for webpack in the package.
  3. Add the code to the entry pint.
  4. Save and compile.

Added description for `blocks.getBlockAttributes` filter
Copy link

github-actions bot commented Aug 31, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: davy440 <[email protected]>
Co-authored-by: akasunil <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Aug 31, 2024
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @davy440! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@davy440 davy440 marked this pull request as draft August 31, 2024 19:12
@davy440 davy440 marked this pull request as ready for review August 31, 2024 19:23
@shail-mehta shail-mehta added the [Type] Developer Documentation Documentation for developers label Sep 1, 2024
@akasunil
Copy link
Member

akasunil commented Sep 3, 2024

Thank you for your contribution!

Is it possible for us to utilize the same simple example function something like other filters example in the same readme? I think this one is a little too technical; since the purpose of this is just to show how to apply the filter, a simple function would do the job.

Copy link
Contributor Author

@davy440 davy440 left a comment

Choose a reason for hiding this comment

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

Modified the example and provided additional info

@davy440
Copy link
Contributor Author

davy440 commented Sep 11, 2024

@akasunil Thanks for the feedback. I have modified the example and provided additional info regarding the filter.
Please review.

Thanks,
Divjot

@akasunil
Copy link
Member

Thanks @davy440 for the ping. I have left couple of suggestions. Hope to get it addressed.

@davy440
Copy link
Contributor Author

davy440 commented Sep 11, 2024

@akasunil Yes, I have provided a simpler example in my most recent commit. Is there something else I'm missing?

docs/reference-guides/filters/block-filters.md Outdated Show resolved Hide resolved
docs/reference-guides/filters/block-filters.md Outdated Show resolved Hide resolved
docs/reference-guides/filters/block-filters.md Outdated Show resolved Hide resolved
docs/reference-guides/filters/block-filters.md Outdated Show resolved Hide resolved
docs/reference-guides/filters/block-filters.md Outdated Show resolved Hide resolved
davy440 and others added 5 commits September 12, 2024 16:31
@davy440
Copy link
Contributor Author

davy440 commented Sep 12, 2024

@akasunil thanks for the above fixes. Didn't pay attention to the above mentioned errors earlier.

Copy link
Member

@akasunil akasunil left a comment

Choose a reason for hiding this comment

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

Thank you @davy440, These looks really good. just one final thing to address and then we are ready to go.

docs/reference-guides/filters/block-filters.md Outdated Show resolved Hide resolved
Thanks for the suggestion.
Not aware of the format since it's my first time.

Co-authored-by: Sunil Prajapati <[email protected]>
Copy link
Member

@akasunil akasunil left a comment

Choose a reason for hiding this comment

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

LGTM!

@davy440
Copy link
Contributor Author

davy440 commented Sep 26, 2024

@akasunil Is there any update regarding the PR? Please let me know if anything is required from my end.

Thank you,
Divjot

@akasunil
Copy link
Member

Hi @davy440 Can you sync the PR with trunk?

@davy440
Copy link
Contributor Author

davy440 commented Sep 28, 2024

@akasunil Just synced the fork with main branch. Showing 11 commits ahead of main branch. Let me know if anyhting else is required.

Thanks

@akasunil akasunil merged commit 6f98f51 into WordPress:trunk Oct 1, 2024
60 checks passed
@github-actions github-actions bot added this to the Gutenberg 19.4 milestone Oct 1, 2024
getdave pushed a commit that referenced this pull request Oct 1, 2024
* Update block-filters.md

Added description for `blocks.getBlockAttributes` filter

* Modified example and provided additional info

* modified example and provided additional info

Explained the parameters accepted by the filter callback function.

* modified example and provided additional info

Fixed parameter names.

* Update docs/reference-guides/filters/block-filters.md

Thanks

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

Thanks for the suggestion.
Not aware of the format since it's my first time.

Co-authored-by: Sunil Prajapati <[email protected]>

---------

Co-authored-by: davy440 <[email protected]>
Co-authored-by: akasunil <[email protected]>
huubl pushed a commit to huubl/gutenberg that referenced this pull request Oct 2, 2024
* Update block-filters.md

Added description for `blocks.getBlockAttributes` filter

* Modified example and provided additional info

* modified example and provided additional info

Explained the parameters accepted by the filter callback function.

* modified example and provided additional info

Fixed parameter names.

* Update docs/reference-guides/filters/block-filters.md

Thanks

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

Thanks for the suggestion.
Not aware of the format since it's my first time.

Co-authored-by: Sunil Prajapati <[email protected]>

---------

Co-authored-by: davy440 <[email protected]>
Co-authored-by: akasunil <[email protected]>
huubl added a commit to huubl/gutenberg that referenced this pull request Oct 2, 2024
draganescu pushed a commit that referenced this pull request Oct 2, 2024
* Update block-filters.md

Added description for `blocks.getBlockAttributes` filter

* Modified example and provided additional info

* modified example and provided additional info

Explained the parameters accepted by the filter callback function.

* modified example and provided additional info

Fixed parameter names.

* Update docs/reference-guides/filters/block-filters.md

Thanks

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

thanks for fix

Co-authored-by: Sunil Prajapati <[email protected]>

* Update docs/reference-guides/filters/block-filters.md

Thanks for the suggestion.
Not aware of the format since it's my first time.

Co-authored-by: Sunil Prajapati <[email protected]>

---------

Co-authored-by: davy440 <[email protected]>
Co-authored-by: akasunil <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants