【Wordpress関数】タームやアーカイブ関係の個別指定タグ(Wordpressテンプレートタグ)

[公開] 2024-08-04 / [更新] 2024-08-16

ついつい忘れがちなのが、一覧(アーカイブ)ページのタイトルやdescriptionの取得、カテゴリページへのリンクなどなど、個別指定のタグ達^^;;

よく使う個別指定のテンプレートタグ(WordPress関数)をまとめました

よく使う個別指定のWordpress関数

テンプレートタグ	( )の指定	( )未指定	戻り値	echo	説明
`single_cat_title()`	前置文字	前置なし	カテゴリ名	不要	カテゴリアーカイブのみ利用可表示ページのタイトル
`category_description()`	`ID`	表示ページ	カテゴリ説明	要	未指定の場合は表示カテゴリアーカイブの説明
`get_cat_ID()`	カテゴリ名	不可	カテゴリ ID	—	カテゴリ名( スラッグではない ) を指定
`get_cat_name()`	`ID`	不可	カテゴリ名	要	指定IDに基づいたタイトル
`get_the_category_by_ID()`	`ID`	不可	カテゴリ名	要	指定IDに基づいたタイトル
`get_category_link()`	`ID`	不可	カテゴリURL	要	指定IDに基づいたURL

テンプレートタグ	( )の指定	( )未指定	戻り値	echo	説明
`single_tag_title()`	前置文字	前置なし	タグ名	不要	タグアーカイブのみ利用可表示ページのタイトル
`tag_description()`	`ID`	表示ページ	タグ説明	要	未指定の場合は表示タグアーカイブの説明
`get_tag_link()`	`ID`	不可	タグURL	要	指定IDに基づいたURL

テンプレートタグ	( )の指定	( )未指定	戻り値	echo	説明
`single_term_title()`	前置文字	前置なし	ターム名	不要	表示されているカテゴリ、タグ、タームのタイトル
`term_description()`	`ID`	表示ページ	ターム説明	要	指定ID (タクソノミー指定は非推奨) 又は表示ページの説明
`get_term_link()`	`ID`, タクソノミー	不可	タームURL	要	「指定ID、タクソノミー」に基づいたタームURL

get_term_link()
タクソノミー( category, post-tag, カスタムタクソノミー )を指定することで、カテゴリ、タグ、タームに対応。

テンプレートタグ	( )の指定	( )未指定	戻り値	echo	説明
`post_type_archive_title()`	前置文字	前置なし	カスタム投稿タイプのタイトル	不要	カスタム投稿タイプアーカイブのみ利用可表示ページのタイトル
`get_post_type_archive_link()`	`投稿タイプ`	不可	カスタム投稿タイプアーカイブURL	要	投稿タイプに基づいたURL

get_post_type_archive_link(get_post_type())
get_post_type() を指定することで、カスタム投稿ベージから一覧ページへのリンクを取得できます

基本的に殆どのアーカイブベージで使えるが、他の関数に比べ癖が強い。場合により別処理が必要です。

テンプレートタグ	( )指定	echo	取得データ
`the_archive_title()`	`(セレクタ, セレクタ)`	不要	表示アーカイブのタイトルを前置きテキスト付きで表示前後を指定できるので、セレクタで囲って表示可能
`get_the_archive_title()`	不要	要	表示アーカイブのタイトルを前置きテキスト付きで取得
`the_archive_description()`	`(セレクタ, セレクタ)`	不要	表示アーカイブの説明を<p>タグ付きで表示前後を指定できるが、指定セレクタは<p>タグの外を囲うだけ ( <p>タグの置き換えではない )
`get_the_archive_description()`	不要	要	表示アーカイブの説明を<p>タグ付きで取得値として使うなら `strip_tags()`等の処理が必要

このコードをアーカイブページの the_archive_title(), get_the_archive_title() の前に書くか、functions.phpに記載すると、prefix (前置きテキスト) が削除されます。

PHP

<?php
add_filter( 'get_the_archive_title_prefix', function($prefix) {
  $prefix = ''; //空文字代入
  return $prefix;
});
?>