PHP Classes
elePHPant
Icontem

WordPress Fields Plugin: Add custom form fields to WordPress interface

Recommend this page to a friend!
  Info   View files View files (7)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2019-02-25 (2 months ago) RSS 2.0 feedNot enough user ratingsTotal: 67 All time: 9,396 This week: 364Up
Version License PHP version Categories
wp-meta-fields 1.0.0The PHP License5HTML, PHP 5, Content management, Blogs
Description Author

This package provides a plugin for WordPress that can add custom form fields to different parts of the user interface.

It can register hooks to be able to add form fields that generation of WordPress administration pages so developers can define actions that will be triggered when those fields are submitted.

The package provides functions to register the form fields, define meta boxes, and display values of meta fields in posts.

Innovation Award
PHP Programming Innovation award nominee
February 2019
Number 10
WordPress is a very popular blog publication platform that often serves other purposes for Web applications.

This package implements a WordPress plugin that can be used to extend WordPress by adding custom fields to the different forms of the WordPress administration interface, so applications can extend WordPress and make it more useful for other purpose besides blog publication.

Manuel Lemos
  Performance   Level  
Name: Mahesh Waghmare <contact>
Classes: 1 package by
Country: India India
Age: 29
All time rank: 4253296 in India India
Week rank: 802 Up65 in India India Up
Innovation award
Innovation award
Nominee: 1x

Details

WP Meta Fields

Easy custom field framework for WordPress theme and plugns.

How to add into theme/plugin?

  1. Download latest zip of framework and unzip into your theme/plugin.
  2. Add below code to initialize framework.
require_once 'wp-meta-fields/wp-meta-fields.php';

You can organize your directory structure as per your requirement. Instead of adding framework in root directory of plugin/theme, I'll use the inc directory. To add the framework.

  1. Create inc directory in your plugin/theme.
  2. Unzip latest release of WP Meta Fields into inc directory.
  3. Include it into your plugin/theme by adding below code.
require_once 'inc/wp-meta-fields/wp-meta-fields.php';

NOTE: Make sure you have the latest version wp-meta-fields. Get the latest version from wp-meta-fields

Use sample plugin

To know how to integrate meta field framework into plugin, Use the sample plugin

How to add meta box?

Use function mf_add_meta_box() to register meta box and its meta fields. It contain parameters which are used for WordPress function add_meta_box()

E.g.

Register meta box for post type Post.

mf_add_meta_box( array(
	'id'       => 'example-all-fields',
	'title'    => __( 'Example - All Fields' ),
	'screen'   => array( 'post' ),
	'context'  => 'normal',
	'priority' => 'default',
	'fields'   => array(
		// ..
	)
));

Where,

| Parameter | Description | |-----------------|-----------------| |id | (string) (Required) Meta box ID (used in the 'id' attribute for the meta box). | | title | (string) (Required) Title of the meta box.| | screen| (string|array|WP_Screen) (Optional) The screen or screens on which to show the box (such as a post type, 'link', or 'comment'). Accepts a single screen ID, WP_Screen object, or array of screen IDs. Default is the current screen. If you have used add_menu_page() or add_submenu_page() to create a new screen (and hence screen_id), make sure your menu slug conforms to the limits of sanitize_key() otherwise the 'screen' menu may not correctly render on your page. Default value: null| | context| (string) (Optional) The context within the screen where the boxes should display. Available contexts vary from screen to screen. Post edit screen contexts include 'normal', 'side', and 'advanced'. Comments screen contexts include 'normal' and 'side'. Menus meta boxes (accordion sections) all use the 'side' context. Global. Default value: 'advanced'| | priority |(string) (Optional) The priority within the context where the boxes should show ('high', 'low'). Default value: 'default'|

How to add fields?

Register single text field which have a unique meta key prefix-1-text our above registered meta box.

mf_add_meta_box( array(
	'id'       => 'example-meta-box',
	'title'    => __( 'Example Meta Box' ),
	'screen'   => array( 'post' ),
	'context'  => 'normal',
	'priority' => 'default',
	'fields'   => array(
		'prefix-1-text' => array(
			'type'        => 'text',
			'title'       => __( 'Text Field', 'textdomain' ),
			'description' => __( 'Simple text field for demonstration purpose.', 'textdomain' ),
			'hint'        => __( 'This is the Text Field for storing the text data for demonstration purpose.', 'textdomain' ),
			'default'     => '',
		),
	)
));

Here,

| Parameter | Description | |-----------------|-----------------| | prefix-1-text | Unique meta key. | | type | Field type. | | title | Field title. | | description | Field description. | | hint | Field hint. | | default | Field default value. |

Above registered field is looks like below screenshot in the post edit window.

All Meta Box

How to print/retrieve meta field value.

To retrieve/print the value of our registered field prefix-1-text use:

[mf meta_key='prefix-1-text']

or

mf_meta( 'prefix-1-text' );

or

echo mf_get_meta( 'prefix-1-text' );

  1. Use shortcode [mf meta_key="META_KEY" post_id="POST_ID"] to print the meta value.

E.g. [mf meta_key='prefix-1-text'] By default it get the current post ID by using function get_the_ID().

OR [mf meta_key='prefix-1-text' post_id='46'] Specific post meta value by passing post ID.

  1. Use function mf_meta() to print the meta value.

E.g. <?php mf_meta( 'prefix-1-text' ); ?> By default it get the current post ID by using function get_the_ID().

OR <?php mf_meta( 'prefix-1-text', 46 ); ?> Specific post meta value by passing post ID.

  1. Use function mf_get_meta() to retrieve the meta value.

E.g. <?php echo mf_get_meta( 'prefix-1-text' ); ?> By default it get the current post ID by using function get_the_ID().

OR <?php echo mf_get_meta( 'prefix-1-text', 46 ); ?> Specific post meta value by passing post ID. E.g.

Field Types

Now, Framework support below build in HTML5 field support.

  • text
  • textarea
  • password
  • color
  • date
  • datetime-local
  • email
  • month
  • number
  • time
  • week
  • url
  • checkbox
  • radio
  • select

Examples

All Meta Field:

/
 * Meta Fields (Screen - Normal)
 */
mf_add_meta_box( array(
	'id'       => 'example-all-fields',
	'title'    => __( 'Example - All Fields' ),
	'screen'   => array( 'post' ),
	'context'  => 'normal',
	'priority' => 'default',
	'fields' => array(
		'prefix-1-text' => array(
			'type'        => 'text',
			'title'       => 'Text Field',
			'description' => 'Text Field field description goes here.',
			'hint' => 'Text Field field description goes here.',
			'default'     => '',
		),
		'prefix-1-textarea' => array(
			'type'        => 'textarea',
			'title'       => 'Textarea',
			'description' => 'Textarea field description goes here.',
			'hint' => 'Textarea field description goes here.',
			'default'     => '',
		),
		'prefix-1-password' => array(
			'type'        => 'password',
			'title'       => 'Password',
			'description' => 'Password field description goes here.',
			'hint' => 'Password field description goes here.',
			'default'     => '',
		),
		'prefix-1-color' => array(
			'type'        => 'color',
			'title'       => 'Color',
			'description' => 'Color field description goes here.',
			'hint' => 'Color field description goes here.',
			'default'     => '#f3f3f3',
		),
		'prefix-1-date' => array(
			'type'        => 'date',
			'title'       => 'Date',
			'description' => 'Date field description goes here.',
			'hint' => 'Date field description goes here.',
			'default'     => '',
		),
		'prefix-1-datetime-local' => array(
			'type'        => 'datetime-local',
			'title'       => 'Date Time Local',
			'description' => 'Date Time Local field description goes here.',
			'hint' => 'Date Time Local field description goes here.',
			'default'     => '',
		),
		'prefix-1-email' => array(
			'type'        => 'email',
			'title'       => 'Email',
			'description' => 'Email field description goes here.',
			'hint' => 'Email field description goes here.',
			'default'     => '',
		),
		'prefix-1-month' => array(
			'type'        => 'month',
			'title'       => 'Month',
			'description' => 'Month field description goes here.',
			'hint' => 'Month field description goes here.',
			'default'     => '',
		),
		'prefix-1-number' => array(
			'type'        => 'number',
			'title'       => 'Number',
			'description' => 'Number field description goes here.',
			'hint' => 'Number field description goes here.',
			'default'     => '',
		),
		'prefix-1-time' => array(
			'type'        => 'time',
			'title'       => 'Time',
			'description' => 'Time field description goes here.',
			'hint' => 'Time field description goes here.',
			'default'     => '',
		),
		'prefix-1-week' => array(
			'type'        => 'week',
			'title'       => 'Week',
			'description' => 'Week field description goes here.',
			'hint' => 'Week field description goes here.',
			'default'     => '',
		),
		'prefix-1-url' => array(
			'type'        => 'url',
			'title'       => 'Url',
			'description' => 'Url field description goes here.',
			'hint' => 'Url field description goes here.',
			'default'     => '',
		),
		'prefix-1-checkbox' => array(
			'type'        => 'checkbox',
			'title'       => 'Checkbox',
			'description' => 'Checkbox field description goes here.',
			'hint'        => 'Checkbox field description goes here.',
			'default'     => true,
		),
		'prefix-1-radio' => array(
			'type'        => 'radio',
			'title'       => 'Radio',
			'description' => 'Radio field description goes here.',
			'hint' => 'Radio field description goes here.',
			'default'     => 'one',
			'choices' => array(
				'one'   => 'One',
				'two'   => 'Two',
				'three' => 'Three',
			),
		),
		'prefix-1-select' => array(
			'type'        => 'select',
			'title'       => 'Select',
			'description' => 'Select field description goes here.',
			'hint' => 'Select field description goes here.',
			'default'     => 'one',
			'choices' => array(
				'one'   => 'One',
				'two'   => 'Two',
				'three' => 'Three',
			),
		),
	)
) );

It generate the meta box and meta fields like below screenshot.

All Meta Box

  Files folder image Files  
File Role Description
Accessible without login Plain text file example-screen-advanced.php Aux. Auxiliary script
Accessible without login Plain text file example-screen-normal.php Aux. Auxiliary script
Accessible without login Plain text file example-screen-side.php Aux. Auxiliary script
Accessible without login Plain text file examples.php Aux. Auxiliary script
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file wp-meta-fields.css Data Auxiliary data
Plain text file wp-meta-fields.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:67
This week:0
All time:9,396
This week:364Up