逆引きゴリラ

News
2021/01/12 設定値の解説記事を 2 件追加しました。
  1. ホーム
  2. フック
  3. snow_monkey_breadcrumbs

snow_monkey_breadcrumbs

フックタイプ

フィルターフック

説明

パンくずの項目を変更します。

補足説明

  • 「パンくず」とは、トップページから現在のページまでの階層を一覧として表示されるコンポーネントを指します。

引数

引数名タイプ説明
$breadcrumbs連想配列(array)パンくず一覧の各項目が格納された連想配列

$breadcrumbs の配列内は下記の定義がされています。

キー名タイプ説明
link文字列(string)パンくずの項目のリンク先 URL 文字列 (文字列が空、または null の場合、現在開かれているページの URL となります)
title文字列(string)パンくずの項目に表示される HTML 文字列

返却値

変数名タイプ説明
$breadcrumbs連想配列(array)パンくず一覧の各項目が格納された連想配列

$breadcrumbs の配列内は引数と同様の定義がされています。

サンプルコード

my-snow-monkey.php
<?php

  … 略 …

  add_filter(
    'snow_monkey_breadcrumbs',
    function( $breadcrumbs ) {

      // パンくず最後の項目を変更する場合の例
      // count( $breadcrumbs ) - 1 で、最後の項目の index を取得しています。
      $breadcrumbs[ count( $breadcrumbs ) - 1 ] = [
        'link' => パンくずの項目のリンク先 URL 文字列,
        'title' => パンくずの項目に表示される HTML 文字列,
      ];

      // パンくず最初の項目を追加する場合の例
      $first_item = [
        'link' => パンくずの項目のリンク先 URL 文字列,
        'title' => パンくずの項目に表示される HTML 文字列,
      ];
      array_unshift( $breadcrumbs, $first_item );

      // 各位置に項目を追加する場合の例
      // 第1引数にはパンくず項目の配列を記述します。
      // 第2引数には追加する項目の位置を記述します。0から始まります。0であれば最初の番目に追加できます。
      // 第3引数には 0 を記述します。( 0 以外を記述した場合、位置が異なります)
      // 第4引数に追加する配列を記述します。
      $add_item = [
        [
          'link' => パンくずの項目のリンク先 URL 文字列,
          'title' => パンくずの項目に表示される HTML 文字列,
        ]
      ];
      array_splice( $breadcrumbs, 1, 0, $add_item );

      // 各項目の削除の例
      // 第1引数にはパンくず項目の配列を記述します。
      // 第2引数には削除する項目の位置を記述します。0から始まります。0であれば最初の番目を削除できます。
      // 第3引数には削除する数を記述します。1項目を削除する場合は1を記述します。
      array_splice( $breadcrumbs, 0, 1 );

		  return $breadcrumbs;
	  }
  );