カスタムメニューを自由にカスタマイズしたい人向け

2015年3月30日 2019年11月7日

mikaduki

wpppppppp
WordPressのカスタムメニューのHTML構造をある程度自由にしたい人向けの記事を今日は書こうと思います。wp_nav_menuって設定値が多いので、初心者には超便利な反面フレームワーク使うような人たちになると迷惑な場合があります。カスタムメニューに設定値で検索したデータくれればこっちでなんとかするってばって思うんですけど、どうやらそれっぽい関数を僕は見つける事ができませんでした。とりあえずwp_nav_menuの項をCODEXをなになに～と読んでみると、カスタムウォーカー機能なるものが存在すると書いてあります。とりあえずこれは何かとか、使い方についてできるだけ説明しようと思います。

自分好みのHTML構造でカスタムメニューが作れる

カスタムウォーカークラスが何か分かりませんが、とりあえずこのクラスを継承して、start_lvlメソッドとstart_elメソッドを編集すれば、好きな構造でカスタムメニューのHTMLを生成できます。

使い方

functions.phpなりなんなりに、どーんとコピペします。


class クラス名は何でもいい extends Walker_Nav_Menu {
  
// add classes to ul sub-menus
function start_lvl( &$output, $depth ) {
    // depth dependent classes
    $indent = ( $depth > 0  ? str_repeat( "\t", $depth ) : '' ); // code indent
    $display_depth = ( $depth + 1); // because it counts the first submenu as 0
    $classes = array(
        'sub-menu',
        ( $display_depth % 2  ? 'menu-odd' : 'menu-even' ),
        ( $display_depth >=2 ? 'sub-sub-menu' : '' ),
        'menu-depth-' . $display_depth
        );
    $class_names = implode( ' ', $classes );
  
    // build html
    $output .= "\n" . $indent . '<ul class="' . $class_names . '">' . "\n";
}
  
// add main/sub classes to li's and links
function start_el( &$output, $item, $depth, $args ) {
    global $wp_query;
    $indent = ( $depth > 0 ? str_repeat( "\t", $depth ) : '' ); // code indent
  
    // depth dependent classes
    $depth_classes = array(
        ( $depth == 0 ? 'main-menu-item' : 'sub-menu-item' ),
        ( $depth >=2 ? 'sub-sub-menu-item' : '' ),
        ( $depth % 2 ? 'menu-item-odd' : 'menu-item-even' ),
        'menu-item-depth-' . $depth
    );
    $depth_class_names = esc_attr( implode( ' ', $depth_classes ) );
  
    // passed classes
    $classes = empty( $item->classes ) ? array() : (array) $item->classes;
    $class_names = esc_attr( implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item ) ) );
  
    // build html
    $output .= $indent . '<li id="nav-menu-item-'. $item->ID . '" class="' . $depth_class_names . ' ' . $class_names . '">';
  
    // link attributes
    $attributes  = ! empty( $item->attr_title ) ? ' title="'  . esc_attr( $item->attr_title ) .'"' : '';
    $attributes .= ! empty( $item->target )    ? ' target="' . esc_attr( $item->target    ) .'"' : '';
    $attributes .= ! empty( $item->xfn )        ? ' rel="'    . esc_attr( $item->xfn        ) .'"' : '';
    $attributes .= ! empty( $item->url )        ? ' href="'  . esc_attr( $item->url        ) .'"' : '';
    $attributes .= ' class="menu-link ' . ( $depth > 0 ? 'sub-menu-link' : 'main-menu-link' ) . '"';
  
    $item_output = sprintf( '%1$s<a%2$s>%3$s%4$s%5$s</a>%6$s',
        $args->before,
        $attributes,
        $args->link_before,
        apply_filters( 'the_title', $item->title, $item->ID ),
        $args->link_after,
        $args->after
    );
  
    // build html
    $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
}
}

wp_nav_menuの引数にwalker => new 継承したクラス名を入れてやると、クラスが呼べます。

     wp_nav_menu(
          array('walker' => new クラス名は何でもいい())
     );

さっき作ったクラスを編集して自分なりのHTMLを作れます。とりあえず、自分は、ulタグとliタグを削除して、aタグに特定のクラスを付けたかったので、


class mainmenunav extends Walker_Nav_Menu {



     function start_lvl( &$output, $depth ) {

         //ラッパーのDivとかulとかnavの設定用メソッド
         
          //入れ子関係を判断して付けるulにつけるクラスを変えてるのではないかと。
         $indent = ( $depth > 0  ? str_repeat( "\t", $depth ) : '' ); // code indent
         $display_depth = ( $depth + 1); // because it counts the first submenu as 0
         $classes = array(
             'sub-menu',
             ( $display_depth % 2  ? 'menu-odd' : 'menu-even' ),
             ( $display_depth >=2 ? 'sub-sub-menu' : '' ),
             'menu-depth-' . $display_depth
             );
         $class_names = implode( ' ', $classes );
       


         //ラッパーが必要な場合ここはコメントアウトしてはいけない。

          //$output .= "\n" . $indent . '<ul class="' . $class_names . '">' . "\n";

         
     }
  
     function start_el( &$output, $item, $depth, $args ) {

         global $wp_query;
         $indent = ( $depth > 0 ? str_repeat( "\t", $depth ) : '' );
       
         // メニューの入れ子関係のフラグ付けプログラム
         $depth_classes = array(
             ( $depth == 0 ? 'main-menu-item' : 'sub-menu-item' ),
             ( $depth >=2 ? 'sub-sub-menu-item' : '' ),
             ( $depth % 2 ? 'menu-item-odd' : 'menu-item-even' ),
             'menu-item-depth-' . $depth
         );
         $depth_class_names = esc_attr( implode( ' ', $depth_classes ) );
       
         // liタグにつけるクラス生成用プログラムじゃないかな
         $classes = empty( $item->classes ) ? array() : (array) $item->classes;
         $class_names = esc_attr( implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item ) ) );
       
         // ここでリストがつく

         //     $output .= $indent . '<li id="nav-menu-item-'. $item->ID . '" class="' . $depth_class_names . ' ' . $class_names . '">';
       
         // Aタグの属性設定
         $attributes  = ! empty( $item->attr_title ) ? ' title="'  . esc_attr( $item->attr_title ) .'"' : '';
         $attributes .= ! empty( $item->target )     ? ' target="' . esc_attr( $item->target     ) .'"' : '';
         $attributes .= ! empty( $item->xfn )        ? ' rel="'    . esc_attr( $item->xfn        ) .'"' : '';
         $attributes .= ! empty( $item->url )        ? ' href="'   . esc_attr( $item->url        ) .'"' : '';
         $attributes .= ' class=" btn btn-dark btn-small ' . ( $depth > 0 ? 'sub-menu-link' : 'main-menu-link' ) . '"';
       
         $item_output = sprintf( '%1$s<a%2$s>%3$s%4$s%5$s</a>%6$s',
             $args->before,
             $attributes,
             $args->link_before,
             apply_filters( 'the_title', $item->title, $item->ID ),
             $args->link_after,
             $args->after
         );
       

         //item_output = 表示されるAタグ
         //item = 表示されるデータの原型
         //depth = 入れ子になってるかどうかのフラグ
         //args = クエリの元だと思う。正直分からん。


         $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
     }
}

こーんな感じで書きました。
とりあえず自分の推測ですが、コメントも書いておいたので、WordPressのカスタムメニューを何とかしたい人は参考にしてみてください。