remove_serialized_parent_block() 関数について解説：WordPress のシリアル化マークアップから親ブロック除去の実装方法

remove_serialized_parent_block()関数は、WordPress のシリアル化マークアップから親ブロックのラッパー部分を除去し、内部ブロックの情報だけを抽出する実装方法です。

これにより、REST API のレスポンスや投稿メタ情報に必要なブロックデータを簡潔に整形でき、効率的なデータ処理が実現されます。

関数の基本仕様

関数の目的と処理概要

この関数は、WordPress のブロックマークアップから不要な親ブロックのコメント部分を除去し、内部ブロックのコンテンツのみを抽出するために設計されています。

入力としてシリアル化された文字列を受け取り、特定の開始および終了タグを元に内部ブロック部分を切り出す処理を行います。

結果として得られる内部ブロックのシリアル化マークアップは、REST API の応答や投稿メタデータの更新など、後続の処理に利用されます。

引数の仕様

この関数が受け取る引数は、シリアル化されたブロックデータ全体を表す文字列です。

引数は必ずしも WordPress 固有のフォーマットに従いますが、ブロックのラッパーとしての親ブロックと内部ブロックがコメントタグで区切られている点が特徴です。

シリアル化文字列の形式

引数として渡される文字列は、例えば以下のような形式となります。

「<!– wp:parentBlock –>」で始まり、内部ブロックの情報が続いた後、「<!– /wp:parentBlock –>」で終了する形式を基本とします。

この中に、内部ブロックのマークアップが含まれており、関数はこれらの情報から余分なラッパー部分を取り除く役割を担います。

返り値の仕様

この関数は、抽出された内部ブロックのマークアップ文字列を返却します。

処理後の文字列は、元のシリアル化データから親ブロックの余分なコメントタグを除去した状態となっています。

返り値の内容は、後続のデータ加工や画面出力の際に利用され、シンプルな内部ブロック構造を担保するのに役立ちます。

内部ブロックのシリアル化マークアップ

返り値として出力される文字列は、柔軟な内部ブロックの構成をそのまま維持しています。

HTMLタグや WordPress 固有のブロックコメントが含まれるため、精度の高いマークアップとして後続処理に活用できる内容となっています。

シリアル化マークアップの解析処理

開始位置の検出方法

解析処理においては、まず内部ブロックの開始位置を正確に特定する必要があります。

これは、親ブロックの終了タグによって認識されるため、タグの位置を検索する方法が採用されています。

親ブロック終了タグ「–>」の検索

シリアル化文字列内で、最初に出現する親ブロックの終了タグ「–>」を検出します。

このタグは親ブロックの終わりを示しており、その直後から内部ブロックが始まるため、タグの位置が判明することが解析処理の重要なポイントとなります。

strpos() 関数の利用

開始位置の検出には、PHP の strpos()関数が用いられます。

strpos()関数は指定する文字列の中から特定の部分文字列の最初の出現位置を返すため、親ブロック終了タグ「–>」の位置を容易に見つけることができます。

たとえば、以下のように記述することで、内部ブロックの開始位置が算出されます。

$startPos = strpos( $serializedBlockData, '-->' ) + strlen( '-->' );

終了位置の検出方法

次に、内部ブロックの終了位置を特定するため、シリアル化文字列の逆方向に検索が行われます。

終了位置を正確に特定することで、不要な親ブロックのマークアップを含まない部分だけを抜き出すことが可能となります。

内部ブロック終了位置の特定

内部ブロックの終了は、親ブロックの開始タグ「<!–」によって示されるケースが多いため、文字列の最後の「<!–」を検出することで、内部ブロックの終端を特定します。

この位置付近が、内部ブロックの貴重なデータの終わりとして利用されます。

strrpos() 関数の利用

終了位置の取得には、PHP の strrpos()関数を利用します。

strrpos()関数は文字列内で最後に出現する指定文字列のインデックスを返すため、内部ブロックの終端を表すタグの位置を正確に求めることが可能です。

具体的には、下記コードのように記述されます。

$endPos = strrpos( $serializedBlockData, '<!--' );

内部ブロック抽出の実装詳細

抽出位置の算出

開始位置と終了位置が特定された後、これらのインデックスを用いて内部ブロックの部分を計算します。

計算結果は、内部ブロック部分の長さとして利用され、後続の処理で文字列を切り出す際の基準となります。

たとえば、算出された開始位置と終了位置の差量が、そのまま内部ブロックのコンテンツの長さを表します。

この計算により、正確な内部ブロックのみを抽出することが可能です。

substr() 関数による切り出し

PHP の substr()関数を利用することで、算出された開始位置から終了位置までの部分文字列を抜き出します。

substr()関数は文字列の一部を簡単に切り出すことができ、抽出処理の核心部分を担います。

以下のコード例は、この処理の流れを示しています。

/**

 * シリアル化されたブロックマークアップから親ブロックミニマルな部分を除去し、内部ブロックのみを返す関数

 *

 * @param string $serializedBlockData ブロック全体のシリアル化されたデータ
 * @return string 内部ブロックのシリアル化マークアップ

 */
function remove_serialized_parent_block( $serializedBlockData ) {
    // 親ブロック終了タグ '-->' の位置を取得し、その直後を内部ブロックの開始位置とする
    $startPos = strpos( $serializedBlockData, '-->' ) + strlen( '-->' );
    // 内部ブロックが終了する位置は、文字列内で最後に出現する '<!--' を基準に特定
    $endPos   = strrpos( $serializedBlockData, '<!--' );
    // 取得した開始位置から、終了位置までの部分を切り出して返す
    return substr( $serializedBlockData, $startPos, $endPos - $startPos );
}
// サンプル呼び出し例
$serializedBlockData = "<!-- wp:parentBlock -->\n<p>親ブロック前部</p>\n<!-- wp:innerBlock -->\n<p>内部ブロック内容</p>\n<!-- /wp:innerBlock -->\n<p>親ブロック後部</p>\n<!-- /wp:parentBlock -->";
$innerContent = remove_serialized_parent_block( $serializedBlockData );
echo $innerContent;

output
<p>親ブロック前部</p>
<!-- wp:innerBlock -->
<p>内部ブロック内容</p>
<!-- /wp:innerBlock -->
<p>親ブロック後部</p>

コード例の説明

関数内では、まず strpos()関数を使って親ブロック終了タグ「–>」の位置を見つけ、その位置からタグの文字数分だけインデックスをずらし、内部ブロックの開始位置として設定しています。

次に、strrpos()関数により、文字列内で最後に出現する親ブロック開始タグ「<!–」の位置を取得し、これを内部ブロックの終了位置としています。

最後に、開始位置と終了位置の差分を計算して、substr()関数で内部ブロック部分だけを切り出す処理を行っています。

コード内には、各処理の流れを簡潔に説明するコメントが含まれており、読みやすさと理解しやすさが意識されています。

WordPress コアとの連携事例

REST API での利用

WordPress の REST API を利用する際、出力されるブロックデータをコンパクトにするために、本関数で抽出された内部ブロックのマークアップが利用されます。

REST API のレスポンスに内部ブロックだけを盛り込むことで、クライアント側へ効率的なデータ転送が実現され、フロントエンドでのレンダリング処理が円滑になります。

投稿メタ情報更新処理との関連

投稿メタ情報の更新処理において、保存するデータはシンプルで整合性のあるものが求められます。

このようなシステムでは、親ブロックの冗長な情報を除外し、必要な内部ブロックだけを抽出する本関数の役割が重要です。

内部ブロックのみを対象に更新することで、データベースへの保存負荷が軽減され、後続のデータ取得時に正確なブロック情報を利用できるメリットがあります。

テンプレートシステムへの適用

テーマやテンプレートファイルでブロック情報を利用する際、事前に抽出された内部ブロックのマークアップを用いることで、各ブロックの構造が一貫性を保った状態でレンダリングされます。

特に、複数のテンプレートパーツやウィジェットに同じブロックデータを適用する場合に、内部ブロックのみを扱うことで、管理が容易になる点が評価されています。

利用上の留意点

シリアル化データの整合性確認

シリアル化されたブロックデータには、必ず特定の開始タグおよび終了タグが存在する前提があります。

加工前に入力データの整合性を確認することで、無効なデータの処理を防ぐ対策が重要です。

予期せぬ形式のデータが渡された場合、正しい抽出が行えず、予期せぬ動作に繋がる可能性があります。

エラー処理と例外管理の実装ポイント

本関数では、タグの位置が見つからなかった場合や、計算されたインデックスが不整合な場合のエラー処理が必要です。

具体的には、strpos() や strrpos() の戻り値が false となる場合の対処や、抽出部分の長さ計算における例外処理を実装することで、堅牢なシステムの構築が可能になります。

これらのエラー処理は、システム全体の信頼性を向上させるために不可欠なポイントとなります。

まとめ

「remove_serialized_parent_block()」関数は、WordPressのシリアル化マークアップから不要な親ブロックを除去し、内部ブロックのマークアップを抽出するために利用されます。

記事では、関数の目的、引数と返り値の仕様、開始位置と終了位置の検出方法、そして内部ブロック抽出の実装手順について解説しています。

また、REST API連携や投稿メタ更新、テンプレートシステムへの適用事例を通じて具体的な利用シーンを示し、エラー処理や整合性チェックのポイントも説明しています。