- サイトデザイン工事中です。ご意見をお寄せください。
- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/cat is ancestor of
目次 |
説明
この条件分岐タグは、カテゴリーが他のカテゴリーの「先祖」カテゴリーであるかどうかをチェックします。真偽値を返す関数のため、TRUEまたはFALSE値を返します。
使い方
<?php cat_is_ancestor_of( $cat1, $cat2 ); ?>
パラメータ
- $cat1
- (int/object) (必須) 親かどうかをチェックしたいカテゴリーの、カテゴリーIDまたはカテゴリーオブジェクト
- 初期値: なし
- $cat2
- (int/object) (必須) 子カテゴリー
- 初期値: なし
戻り値
- (boolean)
- cat1がcat2の親または先祖である場合はTRUE、そうでない場合はFALSE
用例
注
- この関数は、2番目に指定したカテゴリーが1番目に指定したカテゴリーの子または子孫であるかどうかを評価します。
- どれほど遠いレベルの先祖であっても、TRUEを返します。
- パラメータの値は整数値またはオブジェクトでなければなりません。もしパラメータに整数値ではなく、文字表現された整数を指定した場合、cat_is_ancestor_ofはFALSEを返します。
変更履歴
2.1.0より
ソースファイル
cat_is_ancestor_of() は、wp-includes/category.phpに含まれています。
関連
is_home(), is_front_page(), is_search(), is_404(), is_singular(), is_page(), is_attachment(), is_local_attachment(), is_single(), is_sticky(), is_archive(), is_category(), is_tag(), is_author(), is_date(), is_year(), is_month(), is_day(), is_time(), is_admin(), is_preview(), is_paged(), is_page_template(), is plugin active(), is_plugin_page(), is_new_day(), is_feed(), is_trackback(), is_comments_popup(), comments_open(), pings_open(), is_taxonomy(), is_taxonomy_hierarchical(), is_term(), is_user_logged_in(), is_blog_installed(), is_active_sidebar(), is_dynamic_sidebar(), is_active_widget(), in_the_loop(), in_category(), has_tag(), has_excerpt(), has_post_image()