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

タナビーの高梨です。

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

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

今回はプロフィールブロックやショートコードで表示されるプロフィールボックスのユーザー名部分のHTMLタグを編集できるフィルターフック
👉the_author_box_name
です

フックの概要

発火条件

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

使いどころ

プロフィールボックスのユーザー名部分の表示を制御できます。

活用例：

・ユーザー部分のリンクをなくす

・特定のユーザーのみクラスを追加するなどしてデザインを変更する

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

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

引数

$name：（string）ユーザー名部分のHTMLタグ
$user_id:（int）ユーザーID

カスタマイズコード例

ユーザー名のリンクを外す例（公式サイトより）

function customize_the_author_box_name ( $name, $user_id ) {

    $name = strip_tags($name);

    return $name;

}
add_filter('the_author_box_name', 'customize_the_author_box_name', 10, 2 );

注意点

・$name には HTMLタグが含まれている ため、編集時は strip_tags() や wp_kses() を使うと安全に処理できます

・プロフィールボックスを複数箇所で利用している場合、全てに適用されるため、条件分岐 ($user_id など) を活用する必要があります

まとめ

・the_author_box_name はプロフィールボックスの「ユーザー名部分のHTML」を調整できるフィルターフック。

・リンク削除・クラス追加・条件分岐によるデザイン上のカスタムに利用できる。