Drupalの関数（drupal_get_form）を利用してFormAPIで作成したフォームを任意の場所でPHPに呼び出されることができます

drupal_get_formがよく見かける

• hook_menu()のプロパティ’page callback’がよく’drupal_get_form’を呼び出します

  function node_menu() {
    $items['admin/content'] = array(
      'title' => 'Content', 
      'description' => 'Find and manage content.', 
      'page callback' => 'drupal_get_form', 
      'page arguments' => array('node_admin_content'), 
      'access arguments' => array('access content overview'), 
      'weight' => -10, 
      'file' => 'node.admin.inc',
    );
  
    // …
  
    return $items;
  }

• ほかにdrupal_prepare_form, drupal_retrieve_form関数がよく見かけますが、drupal_get_fromとの違いは？

drupal_get_formがretrieving、processing過程を含め、HTMLフォームの取得に対して、drupal_retrieve_formはフォームの構造のみを取得する

• drupal_get_formが最初にキャッシュにこのフォームがあるか否かをチェックして、フォームを取得する
  • もしキャッシュにある場合、form_get_formを呼び出してフォームを返す。
  • もしキャッシュにない場合、drupal_retrieve_formを呼び出してフォームの構造（array、HTMLではない）を取得し、drupal_prepare_formでフォームを返す
• Drupal7のForm APIのワークフローの詳細説明
  

フォーム（form）をカスタマイズ時に、hook_form_alter、hook_form_FORM_ID_alter、hook_form_BASE_FORM_ID_alterの何れかを実装して行います。ここで、既存のフォームを特定するために、そのform_idが必要となってきまして、どこでカスタマイズ先のフォームIDを取得するのかは戸惑いました。

例えば、LDAPモジュールをインストールして、認証関連設定ページ（Home » Administration » Configuration » People » LDAP Configuration のAUTHENTICATIONタブ）で、その設定フォームのform_idを見てみましょう。

• ソースコードをよく読んでみましたが、form_idに関する記述はどこにも記述してないようで、どのようなIDを利用すればよいかはさっぱりわかりませんでした。
• Develモジュール（7.x-1.5）がインストールされていた前提で、hook_form_alter(&$form, &$form_state, $form_id)関数に、渡された引数$formの中身を出力（ dpm($form) ）してみました。
  
• ここで、三つのform_idが出てきました、どれを利用するのでしょうか。
  • #form_id = ldap_authentication_admin_form
  • form_id -> #id = edit-ldap-authentication-admin-form
  • #id = ldap-authentication-admin-form
• ブラウザーでこの設定画面のform_idを探してみました、上記#id（ldap-authentication-admin-form）は設定フォームの属性IDに使用されていることが分かりました
  
• form_id -> #id (edit-ldap-authentication-admin-form)のタイプが「hidden」なので、クライアントとサーバーとのデータ交信用だと思います
• hook_form_alterで使用すべきのは#form_id = ldap_authentication_admin_formだと思います。このIDは、実際にhook_formを実装する関数名でした
  
• Drupalがフォームをビルドするとき、上記IDを生成して、各IDにそれぞれの意味があり、間違わないよう使用しなければならないです。

Drupalのフォーム（From API）が各要素の動作制御（JavaScript）が可能です

• FormAPIで簡単に要素間の動作制御（JavaScriptの拡張）ができます。
• 例えば、２選択肢の一方が選択された、その選択肢に応じるよう別の要素を表示させたい場合、Javascriptで実現する必要があります。ここで、Drupalのform配列にJavaScriptの拡張を記述する「states」を利用すれば良いです

FormAPIでフォーム作成記述に「#states」でjavascriptの拡張を自動的に行います

• 上記コードは以下のとなります

/**
 * Implement hook_form
 */
function your_custom_form($node, &$form_state) {
  $form['type'] = array(
    '#type' => 'radios',
    '#options' => array(
      'agree' => t('賛成'),
      'disagree' => t('反対'),
    ),
    '#title' => t('投票してください'),
  );
  $form['survey'] = array(
    '#type' => 'fieldtext',
    '#title' => t('反対意見'),
    '#states' => array(
      'visible' => array(
        ':input[name="type"]' => array('value' => 'disagree'),
      ),
    ),
  );
}

• 実際に、「states」部分の記述はjQueryのセレクターを利用して、参照先の動きをキャッチし、要素の属性を制御します。
• jQueryのセレクターとその属性のキャッチ方法は以下のようなに行います
  
• 「states」の記述で二つの要素（ラジオボタンと入力テキストボックス）の制御ができるようになります。
• 以下の要素属性が「states」に記述することが可能です：
  • enabled
  • disabled
  • required
  • optional
  • visible
  • invisible
  • checked
  • unchecked
  • expanded
  • collapsed

やりたいこと：一つのURLで複数のステップフォームを作成したいです

• 背景：Drupal7.54、FormAPIでマルチステップフォームの作成
• FormAPIで簡単にフォームを作成します(例：Drupalの関数（drupal_get_form）を利用してFormAPIで作成したフォームを任意の場所でPHPに呼び出されることができます )
• 一つのURLで複数のステップフォームを作成する要望があります

FormAPIでマルチステップフォーム作成の要点：「$form_state」でステップの定義、「form_submit()」関数内でステップの判別とフォームの再構築

• FormAPIでマルチステップフォームを作成時に二つの要点ああります
• 「$form_state」オブジェクトに任意のステップ識別変数を追加します（例：$form_state['ｐａｇｅｒ']）
  • もちろん、$form_state['ｓｔｏｒａgｅ']の利用も可能です
  • 各ステップのフォームで識別文字列を定義します（例：$form_state['pager']='page_1'）
• 各ステップフォームの送信/次へボタンが押されたら、イベントをキャッチするform_submit（）関数内でステップの判別、フォームの再構築を行います
  • ステップの判別：　if($form_state['ｐａｇｅr']=='page_1')
  • 次のステップのフォーム定義：　$form_state['ｐａｇｅr']=='page_2'
  • フォームの再構築：　$form_state['rebuild']==TRUE
    
  • マルチステップのサンプルプログラム（送信ボタンを押すとステップ１とステップ２を交替で表示する）

    /**
     *  メニューでURLの定義
     */
    function your_module_menu() {
      $items['form/multiple-step'] = array(
          'title' => t('Multiple Step Form Test'),
          'page callback' => 'drupal_get_form',
          'page arguments' => array('multiple_step_form'),
          'access arguments' => array('access content'),
      );
      return $items;
    }
    
    /**
     *  マルチステップフォームの定義
     */
    function multiple_step_form($form, &$form_state){
    	switch( $form_state['pager'] ) {
            case  'page_1'  :
            return page_one_form();
            break;
    
            case  'page_2'  :
            return page_two_form();
            break;
    	}
    }
    
    /**
     *  ステップ１ フォームの定義
     */
    function page_one_form( $form, &$form_state ){
    　// ステップの定義
      $form_state['pager'] = "page_1";
    　// 任一のメッセージ表示
      $form['message_field'] = array(
          '#type' => 'markup',
          '#markup' => 'Form Step 1',
      );
      // サブミットボタン
      $form['submit'] = array(
          '#type' => 'submit',
          '#value' => '送信',
      );
    　// サブミットボタンのイベントハンドラー
      $form['#submit'][] = 'page_one_form_submit';
    
      return $form;}
    }
    
    /**
     *  ステップ２ フォームの定義
     */
    function page_two_form( $form, &$form_state ){
      // ステップの定義
    　$form_state['pager'] = "page_two";
    　// 任一のメッセージ表示
      $form['test_form']=array(
          '#type' => 'item',
          '#title' => 'Multiple Step Form',
          '#markup' => '<p>Step ２</p>',
      );
    　// サブミットボタン
      $form['submit'] = array(
          '#type' => 'submit',
          '#value' => '送信',
      );
    　// サブミットボタンのイベントハンドラー
      $form['#submit'][] = 'page_two_form_submit';
      return $form;
    }
    
    /**
     *  ステップ１のボタンイベントハンドラー
     */
    function page_one_form_submit($form, &$form_state){
      $form_state['pager']['card_page']= "page_two";
      $form_state['rebuild'] = true;
      return ;
    }
    
    /**
     *  ステップ２のボタンイベントハンドラー
     */
    function page_two_form_submit($form, &$form_state){
      $form_state['pager']['card_page']= "page_one";
      $form_state['rebuild'] = true;
      return ;
    }