cocoonフック調査～the_author_box_descriptionの使い方と活用例

タナビーの高梨です。

WordPressのテーマ「Cocoon」には、テーマ改変なしでデザインや動作を拡張できる豊富なアクション・フィルターフックが用意されています。

分かる範囲で内容を調査したのでブログにまとめていこうと思います。

今回はプロフィールブロックやショートコードで表示されるプロフィールボックスのプロフィールを編集できるフィルターフック
👉the_author_box_description
です

フックの概要

発火条件

プロフィールボックスの表示タイミングで無条件に１回発火します。

使いどころ

プロフィールボックスのプロフィール部分の表示を編集できます。

プロフィール部分には通常はユーザー設定のプロフィール情報に設定された内容が表示されますが、それを自由に編集することができます。

HTML形式で書くこともできるため、柔軟な表現が可能です。

活用例：

・HTMLタグを付与して見た目を調整したい
・特定ユーザーだけ別の説明文に差し替えたい
・マーカーやアイコンなど独自表現を入れたい

apply_filters呼び出し元のソースコード

echo apply_filters( 'the_author_box_name', $name, $user_id );

引数

$description：（string）ユーザーのプロフィール
$user_id:（int）ユーザーID

カスタマイズコード例

無条件にプロフィールを赤文字に変更する例

unction customize_the_author_box_description ( $description, $user_id ) {

    $description = '<div style="color:red;">' . $description . '</div>';
    return $description;

}
add_filter('the_author_box_description', 'customize_the_author_box_description', 10, 2 );

注意点

・$description は HTML を含めて返してよいため、不必要なタグの混入やXSS対策に注意してください。
不特定多数が編集するサイトでは wp_kses() の使用が安全です。

まとめ

・the_author_box_description はプロフィールボックスの説明文を変更できるフィルターフック。

・HTMLを含めて自由に編集できるため、デザインや表示制御がしやすい。