Page type

Example

<?php

class Video_Page_Type extends Papi_Page_Type {

  /**
   * The type meta options.
   *
   * @return array
   */
  public function meta() {
    return [
      'name'        => 'Video page',
      'description' => 'A page where you can embed videos',
      'template'    => 'pages/video-page.php'
    ];
  }

  /**
   * Register content meta box.
   */
  public function register() {
    $this->box( 'Content', [
      papi_property( [
        'title' => 'Name',
        'slug'  => 'name',
        'type'  => 'string'
      ] ),
      papi_property( [
        'title' => 'Post',
        'slug'  => 'post',
        'type'  => 'post'
      ] ),
      papi_property( [
        'title' => 'Text',
        'slug'  => 'Text',
        'type'  => 'text'
      ] )
    ] );
  }
}

Meta method

The meta is a required method of the page type class. It should return an array containing the required keys.

/**
 * Example of template structure.
 */

themes/
  my-theme/
    pages/
      about-page.php
      contact-page.php
      video-page.php

When you using template key you can get a better structure of all pages type you are using and which template file it used.

When creating a new page you will get a new view before you get the edit view for your page where you should choose which page type to use. This will happen for all post types that uses page types.

Body classes method

<?php

/**
 * Example of `body_classes` method.
 *
 * @return array
 */
public function body_classes() {
  return ['custom-class'];
}

With this method you can add custom body classes to body when a page type is rendered in the WordPress admin.

Box method

This method is used to register all properties, tabs and remove meta boxes as described above.

The box method can has callable method as the second argument that returns a array with properties or tabs.

Read more about that under box section.

Display method

<?php

/**
 * Example of `display` method.
 *
 * @param  string $post_type
 *
 * @return bool
 */
public function display( $post_type ) {
  return $post_type === 'post';
}

This method is use to tell if the page type should be display or not on Add New Page page.

The method will take a $post_type argument. This is useful when the page type is register one more then one post type.

Returning anything else then true will hide the page type.

Default value is true

Help method

<?php

/**
 * Example of `help` method.
 *
 * @return array
 */
public function help() {
  return [
    'Custom title' => 'Custom help text'
  ];
}

Add custom help tabs, array of key/value where the key is the title and the value is the content, since 3.1.0

Help sidebar method

<?php

/**
 * Example of `help_sidebar` method.
 *
 * @return string
 */
public function help_sidebar() {
  return '<p>Hello, world</p>';
}

Add custom html to help sidebar, since 3.1.0

Publish box method

<?php

/**
 * Example of `publish_box` method.
 *
 * @return string
 */
public function publish_box() {
  return '<p>Hello, world</p>';
}

Add custom html to publish box, since 3.1.0

Remove method

<?php

/**
 * Example of `remove` method.
 *
 * @return array
 */
public function remove() {
  return ['commentsdiv', 'editor'];
}

Since 3.0.0 the remove method is removed and replace with a new remove method where you returns a string or array of strings of the post type support or meta box id that should be removed. You can remove both post type support and meta boxes with remove. This is because we removed one of the calls to register method so the boxes isn’t loaded twice. Read more about this in the upgrade guide.

Check out remove_post_type_support for right post type support or remove_meta_box for meta box slugs.

Namespaces

<?php

namespace Foo\Bar;

/**
 * Example of a page type with namespace.
 */
class Test_Page_Type extends \Papi_Page_Type {}

Papi has no problem to work with page types that have namespaces.