WordPress.org

Make WordPress Core

Opened 4 years ago

Last modified 5 months ago

#17851 reopened enhancement

Wrapping Sections with add_settings_section

Reported by: griffinjt Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version: 3.1.3
Component: Administration Keywords: has-patch dev-feedback needs-refresh
Focuses: Cc:

Description

This is my first time reporting, so excuse my ignorance. I just wanted to see about enhancing the add_settings_section function.

As of now, individual sections are not wrapper in any sort of container, which makes no sense to semantic sense to me. Sections should/need to be styled differently, but as of now, you really don't have much control of that.

I propose something similar to the register_sidebar function, looking like this:

add_settings_section( $id, $title, $callback, $page, $args )

$args would accept 3 parameters: before_section, after_section, and section_class.

This way you can style each individual section with relative ease. Just a thought and enhancement to the Settings API.

Thomas

Attachments (2)

17851.diff (1.1 KB) - added by scribu 4 years ago.
17851.2.diff (1.2 KB) - added by scribu 4 years ago.
Added settings-field class

Download all attachments as: .zip

Change History (20)

comment:1 @nacin4 years ago

The goal of the settings API is to relieve the developer of any choices of markup and style. Ideally, the core UI styles should be used wherever possible. It also keeps us flexible -- As an example, we plan to kill the table markup in 3.3.

comment:2 @griffinjt4 years ago

I understand. I just thought it would be nice for UI (e.g. jQuery accordion to keep everything on one page and manageable for lots of options)

Last edited 4 years ago by griffinjt (previous) (diff)

comment:3 @nacin4 years ago

If you need an accordion to keep your options visibly in check, then you probably have too many options :-)

comment:4 @griffinjt4 years ago

Tushay. :)

comment:5 @nacin4 years ago

This is something that might end up happening in #16413.

I think it would be fine to just have a wrapping div with an ID generated from the section ID.

comment:6 @griffinjt4 years ago

Easy and functional. I'll look into that then :)

comment:7 @scribu4 years ago

  • Milestone Awaiting Review deleted
  • Resolution set to duplicate
  • Status changed from new to closed

I like the idea of automatically adding an id attribute.

Closing as duplicate of #16413

comment:8 @scribu4 years ago

  • Component changed from General to Administration
  • Keywords needs-patch 3.3-early added; ui-feedback removed
  • Milestone set to Future Release
  • Resolution duplicate deleted
  • Status changed from closed to reopened

On second thought, #16413 seems pretty messy.

Automatically wrapping sections in a div and adding id attributes to field rows is a piece of cake.

comment:9 @griffinjt4 years ago

That would be perfect. Just something to differentiate between sections is all that is needed :)

@scribu4 years ago

comment:10 @scribu4 years ago

  • Keywords has-patch added; needs-patch removed

I figured that a "settings-field" class isn't necessary, since you can target fields using .form-table tr.

Version 0, edited 4 years ago by scribu (next)

comment:11 @nacin4 years ago

They may not remain tables for long.

@scribu4 years ago

Added settings-field class

comment:12 @scribu4 years ago

Good point; updated patch.

comment:13 @scribu4 years ago

  • Keywords 3.3-early removed
  • Milestone changed from Future Release to 3.3

If we make no progress on the settings api at all, we can at least do this and it will be a nice step forward.

comment:14 @griffinjt4 years ago

Agreed. Simple and can let us have a little more control over appearances. :)

comment:15 @ryan3 years ago

  • Milestone changed from 3.3 to Awaiting Review

Punting enhancements from 3.3.

comment:16 @ryan3 years ago

  • Milestone changed from Awaiting Review to Future Release

comment:17 @chriscct75 months ago

  • Keywords dev-feedback added

comment:18 @DrewAPicture5 months ago

  • Keywords needs-refresh added
Note: See TracTickets for help on using tickets.