크게 4분야로 나누어져 있다.

1. 세팅 등록/해제
2. 필드, 섹션
3. 폼 렌더링
4. 에러

요약 정리한 그림.

wp_settings_api.pdf

wp_options 테이블에 값을 넣기 위한 작업과 관련 깊다.

register_setting 함수는 세팅 항목을 시스템에 등록하는 일을 맡는다.

register_setting( $option_group, $option_name, $sanitize_callback )

• option_group: 아이템들은 그룹화될 수 있다. 집합의 이름을 입력한다.
• option_name: 아이템이 저장될 값. 키 값이라고 보면 된다.
• sanitize_callback: 값을 세정하기 위한 콜백 함수.

unregister_setting( $option_group, $option_name, $sanitize_callback )

MVC 패턴 관점에서 설명하자면 세팅의 <모델>을 정의하는 작업이라고 보면 된다.

add_settings_field( $id, $title, $callback, $page, $section, $args )

• id: 이 필드의 태그가 가질 id. 이 id는 실제로 html 태그의 id 속성으로도 되어야 한다. 하지만 세팅값을 저장하고 불러오는 데 있어 id가 반드시 필요한 것은 아니다.
• title: 필드의 이름. 직접 html 페이지로 출력된다.
• callback: 콜백 함수. 여기서 반드시 필드를 정의하는 html 태그가 출력되어야 한다. 여기서 반드시 지켜야 할 사항이 있다.
  • 콜백 함수는 1개의 인자를 받는다. 이 인자는 이 함수의 마지막 인자인 args이다.
  • 첫번째 인자인 'id'는 여기서 정의되는 태그의 id가 되어야 한다.
  • 태그의 name 속성은 모델에 해당하는 register_setting() 함수에서 입력한 option_name과 같은 값이어야 한다.
  • 태그의 value는 일반적으로 get_option() 함수를 이용해 직접 데이터베이스로부터 값을 가져온다.
• page: 페이지 이름. 워드프레스의 기본 '설정(settings)' 메뉴에는 '일반(general)', '읽기(read)', '쓰기(write)'와 같은 하위 페이지가 기본적으로 지정되어 있다. 그러나 반드시 이 값이어야 할 필요는 없고, 이 필드가 속할 그룹의, 즉 슬러그의 개념으로 생각하면 된다.
• section: 필드는 섹션의 하위 개념으로 생각하면 된다. 그러므로 상위 개념인 섹션의 존재를 명시하기 위해 이 인자가 사용된다. add_settings_section() 함수의 id 값을 여기에 입력하면 된다.
• args: 콜백 함수에 전달될 인자. 배열이며 기본적으로 'id', 'name', 'value' 등을 지정하여 필드의 태그 속성을 정의한다.

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

• id: 이 섹션의 태그가 가질 id. add_settings_field() 함수의 id 인자와 같은 역할을 한다.
• title: 필드의 이름. 직접 html 페이지로 출력된다.
• callback: 콜백 함수. add_settings_field() 함수의 콜백과 같은 역할을 한다.
  • 콜백 함수는 1개의 인자를 받는다. 이 인자는 기본적으로 'id'라는 키를 가지고 있다. 이 키의 값은 첫번째 인자인 id와 동일하다. 즉, 태그의 id 속성을 같이 맞춰 주기 위해 자동적으로 제공된다.
• page: 페이지 이름. add_settings_field() 함수의 페이지와 같은 역할을 한다.

MVC 패턴 관점에서 바라보면 이 두 함수는 <컨트롤>의 역할을 맡는다. 어떤 HTML구조가 지정된 세팅을 담당하는지를 정의해 주기 때문이다.

폼 렌더링을 하기 위해서 프로그래머는 우선 form 태그를 명시적으로 정의해야 한다. 아래는 그 예시이다.

<form method="POST" action="options.php">
<?php settings_fields( 'my-page' );	//pass slug name of page, also referred
                                        //to in Settings API as option group name
do_settings_sections( 'my-page' ); 	//pass slug name of page
submit_button();
?>
</form>

settings_fields( $option_group )

이 함수는 <컨트롤>과 관련이 있다. form 내부의 부가적인 컨트롤, 즉 워드프레스가 부가적으로 사용할 html 태그를 삽입하는 함수이다. 그러므로 반드시 form 태그 안쪽에서 불려야 한다.

• option_group: register_setting() 함수의 인자인 option_group을 여기에도 입력해야 한다.

do_settings_sections( $page )
do_settings_fields( $page, $section )

이 두 함수는 MVC 패턴에서 <뷰>를 담당한다. 직접적으로 컨트롤들을 화면에 그려 내는 역할을 맡는다.

• page: add_settings_section(), add_settings_field() 함수에서 입력한 page 값을 동일하게 입력하면 된다.
• section: 섹션의 id를 입력하면 된다.

add_settings_error( $setting, $code, $message, $type )  
get_settings_errors( $setting, $sanitize )  
settings_errors( $setting, $sanitize, $hide_on_update )