Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maheshwaghmare/wp-meta-fields
Simple WordPress custom fields framework easy integrate with any theme and plugins.
https://github.com/maheshwaghmare/wp-meta-fields
wordpress wordpress-metabox-options wordpress-metaboxes wordpress-plugin
Last synced: about 2 months ago
JSON representation
Simple WordPress custom fields framework easy integrate with any theme and plugins.
- Host: GitHub
- URL: https://github.com/maheshwaghmare/wp-meta-fields
- Owner: maheshwaghmare
- Created: 2019-02-05T15:38:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-23T14:24:37.000Z (almost 5 years ago)
- Last Synced: 2024-04-14T04:44:28.506Z (10 months ago)
- Topics: wordpress, wordpress-metabox-options, wordpress-metaboxes, wordpress-plugin
- Language: PHP
- Homepage:
- Size: 50.8 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WP Meta Fields
Register meta fields for WordPress theme and plugns. Build for WordPress developers.
### Using with Composer
**Install Library**
If you have not composer.json then initialize it with command `composer init`.
if you already have the composer.json then use below command to install the package.
```php
composer require maheshwaghmare/wp-meta-fields
```
**How to use?**
```php
// Load files.
require_once 'vendor/autoload.php';
// Add meta box "Example Meta Box" for the post type 'post' and 'page'.
mf_add_meta_box( array(
'id' => 'example-meta-box',
'title' => __( 'Example Meta Box' ),
'screen' => array( 'post', 'page' ),
'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, We have added a one Text Field for `page` and `post` types.
Our text field meta key is `prefix-1-text`.
We can get the meta filed value with shortcode like `[mf meta_key="prefix-1-text"]`
We can register many other input fields like `text`, `textarea`, `password`, `color` etc. See **Field Types**.
**Remove package**
```php
composer remove maheshwaghmare/wp-meta-fields --update-with-dependencies
```
### 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.
```php
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](https://github.com/maheshwaghmare/wp-meta-fields)
### Use sample plugin
To know how to integrate meta field framework into plugin, Use the [sample plugin](https://github.com/maheshwaghmare/wp-meta-fields-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()](https://developer.wordpress.org/reference/functions/add_meta_box/)
E.g.
Register meta box for post type `Post`.
```php
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.
```php
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.
### How to print/retrieve meta field value.
To retrieve/print the value of our registered field `prefix-1-text` use:
```php
[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.
2. Use function `mf_meta()` to `print` the meta value.
E.g. ``
By default it get the current post ID by using function `get_the_ID()`.
OR ``
Specific post meta value by passing post ID.
3. Use function `mf_get_meta()` to `retrieve` the meta value.
E.g. ``
By default it get the current post ID by using function `get_the_ID()`.
OR ``
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:
```php
/**
* 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.
