acf_pages_by_template_v4.php

<?php
class acf_field_acf_pages_by_template extends acf_field {
  // vars
  var $settings, // will hold info such as dir / path
    $defaults; // will hold default field options
    
  /*
  *  __construct
  *
  *  Set name / label needed for actions / filters
  *
  *  @since 3.6
  *  @date  23/01/13
  */
  function __construct() {
    // vars
    $this->name = 'acf_pages_by_template';
    $this->label = __('Page Object (by template)', 'acf');
    $this->category = __("Relational",'acf'); // Basic, Content, Choice, etc
    $this->defaults = array(
      'page_template' => array('all'),
      'multiple' => 0,
      'allow_null' => 0,
    );
    // do not delete!
    parent::__construct();
    // settings
    $this->settings = array(
      'path' => apply_filters('acf/helpers/get_path', __FILE__),
      'dir' => apply_filters('acf/helpers/get_dir', __FILE__),
      'version' => '1.0.0'
    );
  }
  
  /*
  *  create_options()
  *
  *  Create extra options for your field. This is rendered when editing a field.
  *  The value of $field['name'] can be used (like below) to save extra data to the $field
  *
  *  @type  action
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $field  - an array holding all the field's data
  */
  function create_options( $field ) {
    // defaults?
    $field = array_merge($this->defaults, $field);
    // key is needed in the field names to correctly save the data
    $key = $field['name'];

    ?>
    <tr class="field_option field_option_<?php echo $this->name; ?>">
      <td class="label">
        <label for=""><?php _e("Page template",'acf'); ?></label>
        <p class="description">Choose for which template(s) you want to get pages</p>
      </td>
      <td>
        <?php 
        global $wpdb;
        $page_templates = get_page_templates();
        foreach( $page_templates as $page_template_name => $page_template ) {
          $choices[$page_template] = $page_template_name;
        }
        do_action('acf/create_field', array(
          'type' => 'select',
          'name' => 'fields['.$key.'][page_template]',
          'value' => $field['page_template'],
          'choices' => $choices,
          'multiple' => '1',
        ));
        ?>
      </td>
    </tr>
      <tr class="field_option field_option_<?php echo $this->name; ?>">
      <td class="label">
        <label><?php _e("Allow multiple pages?",'acf'); ?></label>
        <p class="description">If yes, user can select multiple pages. Otherwise, only a single one.</p>
      </td>
      <td>
        <?php 
        do_action('acf/create_field', array(
          'type' => 'radio',
          'name' => 'fields['.$key.'][multiple]',
          'value' => $field['multiple'],
          'choices' => array(
            '1' => __("Yes",'acf'),
            '0' => __("No",'acf'),
          ),
          'layout' => 'horizontal',
        ));
        ?>
      </td>
    </tr>
    <?php
  }
  
  /*
  *  create_field()
  *
  *  Create the HTML interface for your field
  *
  *  @param $field - an array holding all the field's data
  *
  *  @type  action
  *  @since 3.6
  *  @date  23/01/13
  */
  function create_field( $field ) {
    $field = array_merge($this->defaults, $field);
    // vars
    $args = array(
      'numberposts' => -1,
      'post_type' => 'page',
      'orderby' => 'title',
      'order' => 'ASC',
      'post_status' => array('publish', 'private', 'draft', 'inherit', 'future'),
      'sort_column' => 'menu_order, post_title',
      'sort_order' => 'ASC',
      'suppress_filters' => false,
      'meta_key' => '_wp_page_template',
      'meta_value' => ''
    );

    // // ??
    // // load all page templates by default
    // if( !$field['meta_value'] || !is_array($field['meta_value']) || $field['meta_value'][0] == "" )
    // {
    //   global $wpdb;
    //   $field['meta_value'] = get_page_templates();
    // }

    // build choices
    if(! $field['page_template']){
      // todo: load with all templates
      
    }
    $template_name_by_file = array();
    $page_templates = get_page_templates();
    foreach( $page_templates as $template_name => $template_file ) {
      $template_name_by_file[$template_file] = $template_name;
    }

    foreach($field['page_template'] as $page_template ){
      $template_name = $template_name_by_file[$page_template];
      // get pages
      $args['meta_value'] = $page_template;
      $pages = get_pages($args);

      if($pages) {
        foreach($pages as $post) {
          // find page title. Could use get_the_title, but that uses get_post(), so I think this uses less Memory
          $title = '';
          $ancestors = get_ancestors( $post->ID, $post->post_type );
          if($ancestors) {
            foreach($ancestors as $a) {
              $title .= '–';
            }
          }
          $title .= ' ' . apply_filters( 'the_title', $post->post_title, $post->ID );
          // status
          if($post->post_status != "publish") {
            $title .= " ($post->post_status)";
          }
          // WPML
          if( defined('ICL_LANGUAGE_CODE') ) {
            $title .= ' (' . ICL_LANGUAGE_CODE . ')';
          }
          // add to choices
          $field['choices'][$template_name][ $post->ID ] = $title;
        }
        // foreach( $posts as $post )
      } // if($posts)
    } // foreach( $field['page_template'] as $page_template )

    $field['type'] = 'select';
    // create Field HTML
    do_action('acf/create_field', $field);
  }
  
  
  /*
  *  input_admin_enqueue_scripts()
  *
  *  This action is called in the admin_enqueue_scripts action on the edit screen where your field is created.
  *  Use this action to add CSS + JavaScript to assist your create_field() action.
  *
  *  $info  http://codex.wordpress.org/Plugin_API/Action_Reference/admin_enqueue_scripts
  *  @type  action
  *  @since 3.6
  *  @date  23/01/13
  */

  function input_admin_enqueue_scripts()
  {
    // Note: This function can be removed if not used
    
    
    // register ACF scripts
    wp_register_script( 'acf-input-acf_pages_by_template', $this->settings['dir'] . 'js/input.js', array('acf-input'), $this->settings['version'] );
    wp_register_style( 'acf-input-acf_pages_by_template', $this->settings['dir'] . 'css/input.css', array('acf-input'), $this->settings['version'] ); 
    
    
    // scripts
    wp_enqueue_script(array(
      'acf-input-acf_pages_by_template',  
    ));

    // styles
    wp_enqueue_style(array(
      'acf-input-acf_pages_by_template',  
    ));
    
    
  }
  
  
  /*
  *  input_admin_head()
  *
  *  This action is called in the admin_head action on the edit screen where your field is created.
  *  Use this action to add CSS and JavaScript to assist your create_field() action.
  *
  *  @info  http://codex.wordpress.org/Plugin_API/Action_Reference/admin_head
  *  @type  action
  *  @since 3.6
  *  @date  23/01/13
  */

  function input_admin_head()
  {
    // Note: This function can be removed if not used
  }
  
  
  /*
  *  field_group_admin_enqueue_scripts()
  *
  *  This action is called in the admin_enqueue_scripts action on the edit screen where your field is edited.
  *  Use this action to add CSS + JavaScript to assist your create_field_options() action.
  *
  *  $info  http://codex.wordpress.org/Plugin_API/Action_Reference/admin_enqueue_scripts
  *  @type  action
  *  @since 3.6
  *  @date  23/01/13
  */

  function field_group_admin_enqueue_scripts()
  {
    // Note: This function can be removed if not used
  }

  
  /*
  *  field_group_admin_head()
  *
  *  This action is called in the admin_head action on the edit screen where your field is edited.
  *  Use this action to add CSS and JavaScript to assist your create_field_options() action.
  *
  *  @info  http://codex.wordpress.org/Plugin_API/Action_Reference/admin_head
  *  @type  action
  *  @since 3.6
  *  @date  23/01/13
  */

  function field_group_admin_head()
  {
    // Note: This function can be removed if not used
  }


  /*
  *  load_value()
  *
    *  This filter is applied to the $value after it is loaded from the db
  *
  *  @type  filter
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $value - the value found in the database
  *  @param $post_id - the $post_id from which the value was loaded
  *  @param $field - the field array holding all the field options
  *
  *  @return  $value - the value to be saved in the database
  */
  
  function load_value( $value, $post_id, $field )
  {
    // Note: This function can be removed if not used
    return $value;
  }
  
  
  /*
  *  update_value()
  *
  *  This filter is applied to the $value before it is updated in the db
  *
  *  @type  filter
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $value - the value which will be saved in the database
  *  @param $post_id - the $post_id of which the value will be saved
  *  @param $field - the field array holding all the field options
  *
  *  @return  $value - the modified value
  */
  
  function update_value( $value, $post_id, $field )
  {
    // Note: This function can be removed if not used
    return $value;
  }
  
  
  /*
  *  format_value()
  *
  *  This filter is applied to the $value after it is loaded from the db and before it is passed to the create_field action
  *
  *  @type  filter
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $value  - the value which was loaded from the database
  *  @param $post_id - the $post_id from which the value was loaded
  *  @param $field  - the field array holding all the field options
  *
  *  @return  $value  - the modified value
  */
  
  function format_value( $value, $post_id, $field )
  {
    // defaults?
    /*
    $field = array_merge($this->defaults, $field);
    */
    
    // perhaps use $field['preview_size'] to alter the $value?
    
    
    // Note: This function can be removed if not used
    return $value;
  }
  
  
  /*
  *  format_value_for_api()
  *
  *  This filter is applied to the $value after it is loaded from the db and before it is passed back to the API functions such as the_field
  *
  *  @type  filter
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $value  - the value which was loaded from the database
  *  @param $post_id - the $post_id from which the value was loaded
  *  @param $field  - the field array holding all the field options
  *
  *  @return  $value  - the modified value
  */
  
  function format_value_for_api( $value, $post_id, $field )
  {
    // defaults?
    /*
    $field = array_merge($this->defaults, $field);
    */
    
    // perhaps use $field['preview_size'] to alter the $value?
    
    
    // Note: This function can be removed if not used
    return $value;
  }
  
  
  /*
  *  load_field()
  *
  *  This filter is applied to the $field after it is loaded from the database
  *
  *  @type  filter
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $field - the field array holding all the field options
  *
  *  @return  $field - the field array holding all the field options
  */
  
  function load_field( $field )
  {
    // Note: This function can be removed if not used
    return $field;
  }
  
  
  /*
  *  update_field()
  *
  *  This filter is applied to the $field before it is saved to the database
  *
  *  @type  filter
  *  @since 3.6
  *  @date  23/01/13
  *
  *  @param $field - the field array holding all the field options
  *  @param $post_id - the field group ID (post_type = acf)
  *
  *  @return  $field - the modified field
  */

  function update_field( $field, $post_id )
  {
    // Note: This function can be removed if not used
    return $field;
  }

  
}


// create field
new acf_field_acf_pages_by_template();

?>