Meta Field Block

説明

このプラグインは、開発者 / ユーザーがメタ フィールドをフロントエンドのブロックとして表示することができ、ACF フィールドもサポートできます。Query Block などの postId、postType コンテキストを持つ親ブロック内にネストできるほか、単独のブロックとして使用することもできます。

ACF フィールドの HTML 出力とは何ですか ?

1. すべての基本的なフィールドタイプ、文字列を返すか、文字列に変換できるものをサポート – HTML の出力は、get_field 関数により取得できます。

2. リンクタイプ – HTML の出力:

   <a href={url} target={target} rel="noreferrer noopener">{title}</a>
   

   target が _blank でない場合、rel 属性は存在しません

3. 画像タイプ – HTML 出力は、wp_get_attachment_image 関数から取得されます。画像サイズはプレビュー サイズ設定から取得されます。

4. True / False タイプ – 値が true の場合、HML 出力は Yes となり、値が false の場合は No となります。これらのテキスト値を変更するコードスニペットは以下です:

   add_filter( 'meta_field_block_acf_field_true_false_on_text', function ( $on_text, $field, $post_id, $value ) {
     return 'Yep';
   }, 10, 4 );
   
   add_filter( 'meta_field_block_acf_field_true_false_off_text', function ( $off_text, $field, $post_id, $value ) {
     return 'Noop';
   }, 10, 4 );
   

5. チェックボックス / セレクトタイプ – HTML の出力:

   <span class="value-item">{item_value}</span>, <span class="value-item">{item_value}</span>
   

   item_value は、フィールドの戻り形式に応じて、value または label になります。複数の選択値は、, で区切られます。区切り文字を変更するコードスニペットは以下です:

   add_filter( 'meta_field_block_acf_field_choice_item_separator', function ( $separator, $value, $field, $post_id ) {
     return ' | ';
   }, 10, 4 );
   

6. ラジオボタン / ボタングループタイプ – HTML の出力は、フィールドの返り値フォーマットに依存しますので value または label です。

7. ページリンクタイプ、投稿オブジェクトタイプ – 単一値フィールドの HTML 出力:

   <a class="post-link" href={url} rel="bookmark">{title}</a>
   

   複数の値を持つフィールドの場合は以下のようになります:

   <ul>
     <li><a class="post-link" href={url} rel="bookmark">{title}</a></li>
     <li><a class="post-link" href={url} rel="bookmark">{title}</a></li>
   </ul>
   

8. リレーションシップタイプの場合は以下のようになります:

   <ul>
     <li><a class="post-link" href={url} rel="bookmark">{title}</a></li>
     <li><a class="post-link" href={url} rel="bookmark">{title}</a></li>
   </ul>
   

9. タクソノミータイプ – HTML の出力:

   <ul>
     <li><a class="term-link" href={term_url}>{term_name}</a></li>
     <li><a class="term-link" href={term_url}>{term_name}</a></li>
   </ul>
   

10. ユーザータイプ – 単一値フィールドの HTML 出力:

    <a class="user-link" href={author_url}>{display_name}</a>
    

    複数の値を持つフィールドの場合は以下のようになります:

    <ul>
      <li><a class="user-link" href={author_url}>{display_name}</a></li>
      <li><a class="user-link" href={author_url}>{display_name}</a></li>
    </ul>
    

11. 他の複雑なフィールドタイプに対して、カスタム HTML 出力を生成するには、以下のフックを使用できます:

    apply_filters( 'meta_field_block_get_acf_field', $field_value, $post_id, $field, $raw_value )
    

    または、一般的なフックを使用してもかまいません:

    apply_filters( 'meta_field_block_get_block_content', $content, $attributes, $block, $post_id )
    

    フック meta_field_block_get_acf_field のメリットは、フロントエンドとエディターの両方で変更を確認できることです。

    これらのフックについて詳しくは、以下の「コピー & ペースト」の章で学びましょう。

コピー & ペーストのスニペット

Most of the snippets using the hook meta_field_block_get_block_content only affect the value on the front end, not in the editor.
If your fields are ACF Fields, we recommend using the hook meta_field_block_get_acf_field to change the field content, because with that hook you can change the block content for both the front end and the editor. However, some snippets may not work on the editor because we cannot get the context in the REST API request.

1. ブロックの HTML 出力を変更するには ?
   meta_field_block_get_block_content フックを使用します:

   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace `your_field_name` with your unique name.
     if ( 'your_field_name' === $field_name ) {
       $block_content = 'new content';
     }
   
     return $block_content;
   }, 10, 4);
   

   ACF フィールドに対してのみ、フック meta_field_block_get_acf_field を使用します:

   add_filter( 'meta_field_block_get_acf_field', function ( $block_content, $post_id, $field, $raw_value ) {
     $field_name = $field['name'] ?? '';
   
     // Replace `your_field_name` with your unique name.
     if ( 'your_field_name' === $field_name ) {
       $block_content = 'new content';
     }
   
     return $block_content;
   }, 10, 4);
   

   This basic snippet is very powerful. You can use it to display any fields from any posts, terms, users or setting fields. Please see the details in the below use cases.

2. クエリループ内でブロックを投稿へのリンクでラップする方法は ?
   meta_field_block_get_block_content フックを使用します:

   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace `your_field_name` with your unique name.
     if ( 'your_field_name' === $field_name && $block_content !== '' ) {
       $block_content = sprintf('<a href="%1$s">%2$s</a>', get_permalink($post_id), $block_content);
     }
   
     return $block_content;
   }, 10, 4);
   

   ACF フィールドに対してのみ、フック meta_field_block_get_acf_field を使用します:

   add_filter( 'meta_field_block_get_acf_field', function ( $block_content, $post_id, $field, $raw_value ) {
     $field_name = $field['name'] ?? '';
   
     // Replace `your_field_name` with your unique name.
     if ( 'your_field_name' === $field_name && $block_content !== '' ) {
       $block_content = sprintf('<a href="%1$s">%2$s</a>', get_permalink($post_id), $block_content);
     }
   
     return $block_content;
   }, 10, 4);
   

   このちらスニペットは、HTML インラインタグまたは画像のみを含むブロックでのみ機能します。

3. 画像の URL フィールドを画像タグとして表示するには ?
   meta_field_block_get_block_content フックを使用します:

   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace `your_image_url_field_name` with your unique name.
     if ( 'your_image_url_field_name' === $field_name && wp_http_validate_url($block_content) ) {
       $block_content = sprintf('<img src="%1$s" alt="your_image_url_field_name" />', esc_attr($block_content));
     }
   
     return $block_content;
   }, 10, 4);
   

   ACF フィールドに対してのみ、フック meta_field_block_get_acf_field を使用します:

   add_filter( 'meta_field_block_get_acf_field', function ( $block_content, $post_id, $field, $raw_value ) {
     $field_name = $field['name'] ?? '';
   
     // Replace `your_image_url_field_name` with your unique name.
     if ( 'your_image_url_field_name' === $field_name && wp_http_validate_url($block_content) ) {
       $block_content = sprintf('<img src="%1$s" alt="your_image_url_field_name" />', esc_attr($block_content));
     }
   
     return $block_content;
   }, 10, 4);
   

4. 埋め込み URL (YouTube …) フィールドを埋め込み用の iframe として表示するには ?↵
   meta_field_block_get_block_content フックを使用:

   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace `your_embedded_url_field_name` with your unique name.
     if ( 'your_embedded_url_field_name' === $field_name && wp_http_validate_url($block_content) ) {
       $block_content = wp_oembed_get( $block_content, array( 'width' => 1024 ) );
     }
   
     return $block_content;
   }, 10, 4);
   

   ACF フィールドに対してのみ、フック meta_field_block_get_acf_field を使用します:

   add_filter( 'meta_field_block_get_acf_field', function ( $block_content, $post_id, $field, $raw_value ) {
     $field_name = $field['name'] ?? '';
   
     // Replace `your_embedded_url_field_name` with your unique name.
     if ( 'your_embedded_url_field_name' === $field_name && wp_http_validate_url($block_content) ) {
       $block_content = wp_oembed_get( $block_content, array( 'width' => 1024 ) );
     }
   
     return $block_content;
   }, 10, 4);
   

5. How to display multiple meta fields in a block?
   For example, we need to display the full name of a user from two meta fields first_name and last_name.

   // Create a function to build the full name from two meta fields.
   function yourprefix_get_full_name( $post_id ) {
     $first_name = get_post_meta( $post_id, 'first_name', true );
     $last_name  = get_post_meta( $post_id, 'last_name', true );
   
     // If the meta fields are ACF Fields. The code will be:
     // $first_name = get_field( 'first_name', $post_id );
     // $last_name  = get_field( 'last_name', $post_id );
   
     return trim("$first_name $last_name");
   }
   
   // Register a custom rest field for the full name.
   add_action(
     'rest_api_init',
     function () {
         register_rest_field(
           'post', // Can be an array of post types or a singular value like 'post', 'page', 'product' etc.
           'full_name',
           array(
             'get_callback' => function ( $post_array ) {
               return yourprefix_get_full_name( $post_array['id'] );
             },
             'schema'       => array(
               'type' => 'string',
             ),
           )
         );
     }
   );
   
   // Render the block on the front end.
   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     if ( 'full_name' === $field_name ) {
       $block_content = yourprefix_get_full_name( $post_id );
     }
   
     return $block_content;
   }, 10, 4);
   

   Put the above snippet in your theme or plugin, then choose the field type as custom rest field and input the field name as full_name. Please make sure the rest field name is unique.

6. How to display a term meta field?
   For example, we need to display the value of a custom field named cat_attr for the product_cat taxonomy.

   // Create a function to build the value for the field.
   function yourprefix_get_attr_value( $term_id ) {
     $cat_attr_value = get_term_meta( $term_id, 'cat_attr', true );
   
     // If the meta field is an ACF Field. The code will be:
     // $cat_attr_value = get_field( 'cat_attr', 'term_' . $term_id );
   
     return $cat_attr_value;
   }
   
   // Render the block on the front end.
   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace `unique_name_for_cat_attr` with your unique name.
     if ( 'unique_name_for_cat_attr' === $field_name && is_tax( 'product_cat' ) ) {
       $term_id = get_queried_object_id();
       $block_content = yourprefix_get_attr_value( $term_id );
     }
   
     return $block_content;
   }, 10, 4);
   

   Put the above snippet in your theme or plugin, drag the block into the product_cat taxonomy template, then choose the field type as custom rest field or meta and input the field name as unique_name_for_cat_attr. You can customize this snippet to display custom fields for a specific term on any page, or template.

7. How to display a setting field?
   For example, we need to display a setting field named footer_credit on the footer template part of the site.

   // Create a function to build the value for the field.
   function yourprefix_get_footer_credit_text() {
     $footer_credit_text = get_option( 'footer_credit', '' );
   
     // If the field is an ACF Field. The code will be:
     // $footer_credit_text = get_field( 'footer_credit', 'option' );
   
     return $footer_credit_text;
   }
   
   // Render the block on the front end.
   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace `unique_name_for_footer_credit` with your unique name.
     if ( 'unique_name_for_footer_credit' === $field_name ) {
       $block_content = yourprefix_get_footer_credit_text();
     }
   
     return $block_content;
   }, 10, 4);
   

   ACF フィールドに対してのみ、フック meta_field_block_get_acf_field を使用します:

   add_filter( 'meta_field_block_get_acf_field', function ( $block_content, $post_id, $field, $raw_value ) {
     $field_name = $field['name'] ?? '';
   
     // Replace `unique_name_for_footer_credit` with your unique name.
     if ( 'unique_name_for_footer_credit' === $field_name ) {
       $block_content = yourprefix_get_footer_credit_text();
     }
   
     return $block_content;
   }, 10, 4);
   

   Put the above snippet in your theme or plugin, drag the block into the template, then choose the field type as custom rest field or meta and input the field name as unique_name_for_footer_credit.

8. ユーザーのカスタムフィールドを作者テンプレートで表示したり、ログインしているユーザーや他のユーザーのカスタムフィールドを表示するには ?

   // Create a function to build the value for the field.
   function yourprefix_get_user_field( $user_id ) {
     $user_field_value = get_user_meta( $user_id, 'your_field_name', true );
   
     // If the meta field is an ACF Field. The code will be:
     // $user_field_value = get_field( 'your_field_name', 'user_' . $user_id );
   
     return $user_field_value;
   }
   
   // Render the block on the front end.
   add_filter( 'meta_field_block_get_block_content', function ( $block_content, $attributes, $block, $post_id ) {
     $field_name = $attributes['fieldName'] ?? '';
   
     // Replace your_field_name with your unique name.
     if ( 'your_field_name' === $field_name && is_author() ) {
       $user_id = get_queried_object_id();
       $block_content = yourprefix_get_user_field( $user_id );
     }
   
     // If you want to display meta fields for logged-in users, then the code would be:
     // if ( 'your_field_name' === $field_name && is_user_logged_in() ) {
     //   $user_id = get_current_user_id();
     //   $block_content = yourprefix_get_user_field( $user_id );
     // }
   
     return $block_content;
   }, 10, 4);
   

   Put the above snippet in your theme or plugin, drag the block into the template, then choose the field type as custom rest field or meta and input the field name as your_field_name.

If this plugin is useful for you, please do a quick review and rate it on WordPress.org to help us spread the word. I would very much appreciate it.

もし興味がありましたら、他のプラグインもチェックしてみてください:

• Content Blocks Builder – ブロックエディターで、サイト用のブロック、パターン、またはバリエーションを簡単に作成するためのツール。
• Block Enhancements – A plugin to add more useful features to blocks likes: icons, box-shadow, transform…
• Icon separator – A tiny block just like the core/separator block but with the ability to add an icon to it.
• SVG Block – A block to insert inline SVG images easily and safely. It also bundles with more than 3000 icons and some common non-rectangular dividers.
• Counting Number Block – 数字のカウント効果を持つ数字を表示するためのブロックです。
• Breadcrumb Block – JSON-LD 構造化データをサポートする、シンプルなパンくずリストブロックです。
• Better Youtube Embed Block – サイトの動作を遅くさせることなく、YouTube の動画を埋め込むことができます。

このプラグインは @wordpress/create-block を使用して開発されています。