This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* register a test post type just for the examples
* @return void
*/
add_action( 'init', 'x_init_custom_post_types' );
function x_init_custom_post_types() {
$labels = array(
'name' => _x('Tests', 'post type general name'),
'singular_name' => _x('Test', 'post type singular name'),
'add_new' => _x('Add New', 'Test'),
'add_new_item' => __('Add New Test'),
'edit_item' => __('Edit Test'),
'new_item' => __('New Test'),
'all_items' => __('All Tests'),
'view_item' => __('View Test'),
'search_items' => __('Search Tests'),
'not_found' => __('No Tests found'),
'not_found_in_trash' => __('No Tests found in Trash'),
'parent_item_colon' => '',
'menu_name' => 'Tests'
);
$args = array(
'labels' => $labels,
'public' => true,
'publicly_queryable' => true,
'show_ui' => true,
'show_in_menu' => true,
'query_var' => true,
'rewrite' => true,
'capability_type' => 'post',
'has_archive' => true,
'hierarchical' => false,
'menu_position' => null,
'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'comments' )
);
register_post_type('x_test', $args);
}
/**
* register custom metadata groups and fields
* this is the example code that you should use
* make sure to use the 'admin_init' hook as below
* @return void
*/
add_action( 'admin_init', 'x_init_custom_fields' );
function x_init_custom_fields() {
// check that the metadata manager plugin is active by checking if the two functions we need exist
if( function_exists( 'x_add_metadata_group' ) && function_exists( 'x_add_metadata_field' ) ) {
// adds a new group to the test post type
x_add_metadata_group( 'x_metaBox1', 'x_test', array(
'label' => 'Group with Multiple Fields'
) );
// adds another group to the test post type + posts + users
x_add_metadata_group( 'x_metaBox2', array( 'x_test', 'post', 'user' ), array(
'label' => 'Group for Post and User'
) );
// adds a text field to the first group
x_add_metadata_field('x_fieldName1', 'x_test', array(
'group' => 'x_metaBox1', // the group name
'description' => 'This is field #1. It\'s a simple text field.', // description for the field
'label' => 'Text Field', // field label
'display_column' => true // show this field in the column listings
));
// adds a text field to the 2nd group
x_add_metadata_field('x_fieldName2', 'x_test', array(
'group' => 'x_metaBox1',
'display_column' => 'My Column (with Custom Callback)', // show this field in the column listings
'display_column_callback' => 'fieldName2_columnCallback', // custom function to display the column results (see below)
'label' => 'Text with Custom Callback',
));
// adds a cloneable textarea field to the 1st group
x_add_metadata_field('x_fieldTextarea1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'textarea',
'multiple' => true,
'label' => 'Repeatable Text Area',
));
// adds a readonly textarea field to the 1st group
x_add_metadata_field('x_fieldTextareaReadOnly1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'textarea',
'readonly' => true,
'label' => 'Read Only Text Area',
));
// adds a readonly text field to the 1st group
x_add_metadata_field('x_fieldTextReadOnly1', 'x_test', array(
'group' => 'x_metaBox1',
'readonly' => true,
'label' => 'Read Only Text Area',
));
// adds a wysiwyg (full editor) field to the 2nd group
x_add_metadata_field('x_fieldWysiwyg1', array('x_test', 'user'), array(
'group' => 'x_metaBox2',
'field_type' => 'wysiwyg',
'label' => 'TinyMCE / Wysiwyg field',
));
// adds a datepicker field to the 1st group
x_add_metadata_field('x_fieldDatepicker1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'datepicker',
'label' => 'Datepicker field',
));
// adds an upload field to the 1st group
x_add_metadata_field('x_fieldUpload1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'upload',
'label' => 'Upload field',
));
// adds a checkbox field to the first group
x_add_metadata_field('x_fieldCheckbox1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'checkbox',
'label' => 'Checkbox field',
));
// adds a radio button field to the first group
x_add_metadata_field('x_fieldRadio1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'radio',
'values' => array( // set possible value/options
'option1' => 'Option #1', // key => value pair (value is stored in DB)
'option2' => 'Option #2',
),
'label' => 'Radio field',
));
// adds a select box in the first group
x_add_metadata_field('x_fieldSelect1', 'x_test', array(
'group' => 'x_metaBox1',
'field_type' => 'select',
'values' => array( // set possible value/options
'option1' => 'Option #1', // key => value pair (value is stored in DB)
'option2' => 'Option #2'
),
'label' => 'Select field',
));
// adds a field to posts and users
x_add_metadata_field('x_fieldName2', array( 'post', 'user' ), array(
'group' => 'x_metaBox2',
'label' => 'Text field',
));
// adds a field with a custom display callback (see below)
x_add_metadata_field('x_fieldCustomHidden1', 'x_test', array(
'group' => 'x_metaBox1',
'display_callback' => 'fieldCustomHidden1_display', // this function is defined below
'label' => 'Hidden field',
));
// field with capabilities limited
x_add_metadata_field('x_cap-limited-field', 'x_test', array(
'label' => 'Cap Limited Field (edit_posts)',
'required_cap' => 'edit_posts' // limit to users who can edit posts
));
// field with role limited
x_add_metadata_field('x_author-cap-limited-field', 'user', array(
'label' => 'Cap Limited Field (author)',
'required_cap' => 'author' // limit to authors
));
// comment field
x_add_metadata_field('x_commentField1', 'comment', array(
'label' => 'Field for Comment',
'display_column' => true
));
// field that exludes posts
x_add_metadata_field('x_fieldNameExcluded1', 'post', array(
'description' => 'This field is excluded from Post ID#2476',
'label' => 'Excluded Field',
'exclude' => 2476
));
// field that includes certain posts only
x_add_metadata_field('x_fieldNameIncluded1', 'post', array(
'description' => 'This field is only included on Post ID#2476',
'label' => 'Included Field',
'include' => 2476
));
}
}
/**
* this is an example of a column callback function
* it echoes out a bogus description, but it's just so you can see how it works
*
* @param string $field_slug the slug/id of the field
* @param object $field the field object
* @param string $object_type what object type is the field associated with
* @param int $object_id the ID of the current object
* @param string $value the value of the field
* @return void
*/
function fieldName2_columnCallback( $field_slug, $field, $object_type, $object_id, $value ) {
echo sprintf( 'The value of field "%s" is %s. Here\'s a LOLCat', $field_slug, $value ? $value : 'not set' );
}
/**
* this is another example of a custom callback function
* we've chosen not to include all of the params this time
*
* @param string $field_slug the slug/id of the field
* @param object $field the field object
* @param string $object_type what object type is the field associated with
* @return void
*/
function fieldCustomHidden1_display( $field_slug, $field, $value ) {
if( ! $value ) $value = 'This is a secret hidden value! Don\'t tell anyone!';
?>
This is a hidden field rendered with a custom callback. The value is "".
