• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get category by path

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

カテゴリースラッグを含む URL に基づいてカテゴリーを取得します。

$category_path パラメータを分解してカテゴリースラッグを取り出します。

子カテゴリーのパスが見つかるか試して、あればそれを返します。もしマッチする子カテゴリーがなく、$full_match が false であれば、スラッグがマッチした先頭のカテゴリーを返します。そうでなければ null を返します。

失敗すると WP_Error オブジェクトを返す場合があるので、この関数を使うときはチェックしてください。

使い方

<?php get_category_by_path( $category_path, $full_match, $output ) ?>

パラメータ

$category_path
文字列) (必須) カテゴリースラッグを含む URL。
初期値: なし
$full_match
真偽値) (オプション) フルパスとのマッチを強制するかどうか。
初期値: true
$output
文字列) (オプション) 返り値の種類。定数 OBJECT, ARRAY_A または ARRAY_N のいずれか。
初期値: OBJECT

返り値

(null|オブジェクト|配列) 
失敗すると null を返します。成功するとカテゴリーを $output の指定に応じた型で返します。

用例

デフォルトの使い方

<?php 
$categ = get_category_by_path( 'uncategorized' );
echo "Category " . $categ->name;
?>

参考

更新履歴

新規導入: 2.1.0

ソースファイル

get_category_by_path()wp-includes/category.php にあります。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_category_by_path最新版との差分