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

Added block and content resolver for CoreFootnotes #335

Closed
wants to merge 2 commits into from
Closed

Added block and content resolver for CoreFootnotes #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ae09aa
Added block and content resolver for CoreFootnotes
colinmurphy Jan 20, 2025
d1ce72c
Apply suggestions from code review
colinmurphy Jan 21, 2025
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
45 changes: 45 additions & 0 deletions .changeset/eighty-cameras-join.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
"@wpengine/wp-graphql-content-blocks": minor
---

Added content resolver for CoreFootnotes when the post_meta isn't loaded


```gql
fragment CoreFootnotesBlockFragment on CoreFootnotes {
innerBlocks {
renderedHtml
}
}

query Post($id: ID!) {
post(id: $id, idType: DATABASE_ID) {
databaseId
editorBlocks {
...CoreFootnotesBlockFragment
}
}
}
```


```json
{
"data": {
"post": {
"databaseId": 16,
"editorBlocks": [
{},
{
"innerBlocks": [
{
"renderedHtml": "<ol class=\"footnotes\"><li id=\"d4051e5e-1547-49ff-ab6d-bec1caa6aabc\"><a href=\"https://wpengine.com/about-us/\">https://wpengine.com/about-us/</a></li><li id=\"2e79de23-68a8-42eb-87ab-1f2467a21752\"><a href=\"https://wpengine.com/support/\">https://wpengine.com/support/</a></li></ol>"
}
]
},
{}
]
}
}
}
```
27 changes: 27 additions & 0 deletions includes/Blocks/CoreFootnotes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php
/**
* Core Paragraph Block
*
* @package WPGraphQL\ContentBlocks\Blocks
*/

namespace WPGraphQL\ContentBlocks\Blocks;

/**
* Class CoreParagraph
*/
class CoreFootnotes extends Block {
/**
* {@inheritDoc}
*
* @var array|null
*/
protected ?array $additional_block_attributes = [
'cssClassName' => [
'type' => 'string',
'selector' => 'p',
'source' => 'attribute',
'attribute' => 'class',
],
];
}
52 changes: 52 additions & 0 deletions includes/Data/ContentBlocksResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ private static function handle_do_block( array $block ): ?array {
$block = self::populate_post_content_inner_blocks( $block );
$block = self::populate_reusable_blocks( $block );
$block = self::populate_pattern_inner_blocks( $block );
$block = self::populate_core_footnotes_inner_blocks( $block );
Copy link
Contributor

Choose a reason for hiding this comment

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

But core/footnotes doesn't have inner blocks...
https://github.com/WordPress/gutenberg/blob/be5ce8aefa49b394a57aa540d9c9b091510ed8f1/packages/block-library/src/footnotes/index.php#L19
https://github.com/WordPress/gutenberg/blob/be5ce8aefa49b394a57aa540d9c9b091510ed8f1/packages/block-library/src/footnotes/edit.js#L49 ...

Copy link
Member

@theodesp theodesp Jan 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I was actually able to render the footnotes HTML without checking out this branch. This is on the main branch:

{
  posts {
    nodes {
      editorBlocks {
        ...on CoreFootnotes {
          type
          renderedHtml
        }
      }
    }
  }
}

{
  "data": {
    "posts": {
      "nodes": [
        {
          "editorBlocks": [
            {
              "type": "CoreFootnotes",
              "renderedHtml": "<ol class=\"wp-block-footnotes\"><li id=\"183aa597-72fa-49da-8ea2-73aff3387d88\">Another footnote <a href=\"#183aa597-72fa-49da-8ea2-73aff3387d88-link\" aria-label=\"Jump to footnote reference 1\">↩︎</a></li><li id=\"d6700ca9-32d4-4f18-ad7d-0f6b00d99137\">footnote 1 <a href=\"#d6700ca9-32d4-4f18-ad7d-0f6b00d99137-link\" aria-label=\"Jump to footnote reference 2\">↩︎</a></li></ol>"
            },

          ]
        },
       }
}

Do we really need to expose the individual footnote items from this list? I'm not sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@theodesp @justlevine I think if we can get the data (as per @theodesp GQL query) then is there any need for this? I don't think we should add any new blocks/logic if we can already get the data? The other thing is footnotes are directly correlated with content so not sure if adding a new block for footnotes is needed on reflection.

Copy link
Contributor

Choose a reason for hiding this comment

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

agree there's no need, and personally don't see the value, especially versus the cost of maintaining this (and any other manual deviation that we cant auto-infer from WP core in our schema generation)

Unit tests are always nice to alert us if renderedHtml or something else changes in the future, but I don't see that in this diff anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @justlevine

I don't see any point either if we can just query the data. I will close this PR out. Thanks for the really good feedback aswell.


// Prepare innerBlocks.
if ( ! empty( $block['innerBlocks'] ) ) {
Expand Down Expand Up @@ -292,6 +293,56 @@ private static function populate_pattern_inner_blocks( array $block ): array {
}

$block['innerBlocks'] = $resolved_patterns;

return $block;
}

/**
* Populates the innerBlocks for core/footnotes
*
* @param array<string,mixed> $block The block to populate.
*
* @return array<string,mixed> The populated block.
*/
private static function populate_core_footnotes_inner_blocks( array $block ): array {

if ( 'core/footnotes' !== $block['blockName'] ) {
return $block;
}

$post = get_post();
if ( ! is_object( $post ) || ! is_a( $post, \WP_Post::class ) ) {
return $block;
}

$post_meta = get_post_meta( $post->ID, 'footnotes', true );
if ( ! $post_meta ) {
return $block;
}

$content = json_decode( $post_meta, true );
if ( empty( $content ) ) {
return $block;
}

$html = '';
/** @var array{id: string, content: string} $footnote */
foreach ( $content as $footnote ) {
$id = $footnote['id'] ?? null;
$content = $footnote['content'] ?? null;
if ( ! $content ) {
continue;
}

$html .= "<li id=\"{$id}\">{$content}</li>";
}

$parsed_blocks = parse_blocks( "<ol class=\"footnotes\">{$html}</ol>" );

if ( empty( $parsed_blocks ) ) {
return $block;
}
$block['innerBlocks'] = $parsed_blocks;
return $block;
}

Expand All @@ -307,6 +358,7 @@ private static function flatten_block_list( $blocks ): array {
foreach ( $blocks as $block ) {
$result = array_merge( $result, self::flatten_inner_blocks( $block ) );
}

return $result;
}

Expand Down
Loading