WordPress.org

Make WordPress Core

Opened 12 months ago

Closed 8 months ago

#24101 closed enhancement (wontfix)

Argument for separating wp_nav_menu items

Reported by: Clorith Owned by:
Milestone: Priority: normal
Severity: normal Version: 3.6
Component: Menus Keywords: has-patch
Focuses: Cc:

Description

There is no proper way to add separators between menu items without generating custom walkers for menus.

The use of menu elements with separators are great for page styling where one doesn't need a menu container like in common primary navigation areas, but rather just want a quick list for example in a page footer.

I feel having to use a custom walker for this purpose is more work then need be, for a feature that would make sense to include with core, the below patch introduces the separator argument to the mix to address this.

wp_nav_menu( array( 'separator' => ' | ' ) );

The above would output a menu as Menu item | Menu item 2 | Menu item 3

Attachments (1)

24101.patch (1.3 KB) - added by Clorith 12 months ago.

Download all attachments as: .zip

Change History (5)

Clorith12 months ago

comment:1 toscho12 months ago

  • Keywords close added

You can do that already with CSS or a filter on walker_nav_menu_start_el.

Why is the separator at the end of the item and not at the start?

There is a typo: esparator

Make sure not to catch the wrong content with the regex: 'separator' => 'a' would ruin the menu currently.

The regex is probably very expensive on large menus. Why didn’t you use a counter and a plain additional string instead?

What happens with nested menus?

I think this is plugin/theme territory. The current walker is complex enough, and most people don’t need more arguments.

comment:2 Clorith12 months ago

That was a terrible place to have a silly typo, my bad on that.

I still feel this is a valid enhancement though, as having to use custom menu walkers for something that you find many sites use is (in my opinion) bad.

The reason why it doesn't add the separator before a menu element is that a separator should come between each one. It was cleaner to use a regex approach, and it shouldn't add any noticeable performance decrease as it will start from the end, and stop after finding a single instance of the separator, but maybe switching it to use a prefixed separator and removing the first instance could be an approach to prevent messing up in case of child menus.

But yes, some added safeguards might not be a bad idea, I don't see someone adding "a" as a separator but suggestions on approaching this are more than welcome so that I can revise the patch and amend it appropriately to suit everyones needs.

comment:3 follow-up: nacin8 months ago

Would this be better achieved these days with :before/:after content: CSS?

comment:4 in reply to: ↑ 3 helen8 months ago

  • Keywords close removed
  • Milestone Awaiting Review deleted
  • Resolution set to wontfix
  • Status changed from new to closed

Replying to nacin:

Would this be better achieved these days with :before/:after content: CSS?

Yes, or a border and :first-child/:last-child. It's not content.

Note: See TracTickets for help on using tickets.