README

Dionysos Wordpress Field

This component is a part of the Olympus Dionysos fields for WordPress. It uses a duplicate findPosts WordPress custom modal to manage field.

composer require getolympus/olympus-dionysos-field-wordpress

Field initialization • Variables definitions • Texts definition • Accepted types • Retrive data • Release history • Contributing

Field initialization

Use the following lines to add a wordpress field in your WordPress admin pages or custom post type meta fields:

return \GetOlympus\Dionysos\Field\Wordpress::build('my_wordpress_field_id', [
    'title'       => 'Which is your favourite post?',
    'default'     => [],
    'description' => 'Tell us which one did like this week.',
    'field'       => 'ID',
    'multiple'    => false,
    'type'        => 'post',
    'settings'    => [],

    /**
     * Texts definition
     * @see the `Texts definition` section below
     */
    't_addblock_title' => 'Click on the edit button',
    't_addblock_description' => 'Click on the "+" button to add your item.',
    't_addblocks_description' => 'Click on the "+" button to add a new item.',
    't_addblock_label' => 'Add',
    't_editblock_label' => 'Edit',
    't_removeblock_label' => 'Remove',

    't_modaltitle_label' => 'Choose a content',
    't_modalclose_label' => 'Close',
    't_modalsearch_label' => 'Search',
    't_modalsubmit_label' => 'Select',

    't_ajaxerror_label' => 'No item found',
]);

Variables definitions

Notes:

Set multiple to true to display checkboxes instead of radio buttons
field variable is used to let you retrieve the data you need, depending on type value (for example: in the 'type' => 'term' case, you'll get term_id by default)

Texts definition

Accepted types

categories or category (see get_categories on WordPress reference for field and settings variables)
menus or menu (see wp_get_nav_menus on WordPress reference for field and settings variables)
pages or page (see get_pages on WordPress reference for field and settings variables)
posts or post (see wp_get_recent_posts on WordPress reference for field and settings variables)
posttypes or posttype (see get_post_types on WordPress reference for field and settings variables)
tags or tag (see get_the_tags on WordPress reference for field and settings variables)
taxonomies or taxonomy (see get_taxonomies on WordPress reference for field and settings variables)
terms or term (see get_terms on WordPress reference for field and settings variables)
users or user (see get_users on WordPress reference for field and settings variables)

Retrive data

Retrieve your value from Database with a simple get_option('my_wordpress_field_id', []) (see WordPress reference):

// Get wordpress from Database
$wordpress = get_option('my_wordpress_field_id', []);

if (!empty($wordpress)) {
    echo '<ul>';

    foreach ($wordpress as $post_id) {
        echo '<li>'.get_the_title($post_id).'</li>';
    }

    echo '</ul>';
}

Release history

Contributing

Fork it (https://github.com/GetOlympus/olympus-dionysos-field-wordpress/fork)
Create your feature branch (git checkout -b feature/fooBar)
Commit your changes (git commit -am 'Add some fooBar')
Push to the branch (git push origin feature/fooBar)
Create a new Pull Request

Built with ♥ by Achraf Chouk ~ (c) since a long time.

getolympus / olympus-dionysos-field-wordpress

Maintainers

Details