Simple Fields API Documentation
Index
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

simple_fields::action_pre_get_posts_meta() — Method in class simple_fields
If sfmetakey is set then that is assumed to be the slugs of a field group and a field and the metakey of the value will be replaced by the metakey value of that simple field-field
simple_fields::admin_enqueue_scripts() — Method in class simple_fields
Enqueue styles and scripts, but on on pages that use simple fields Should speed up the loading of other pages a bit
simple_fields::admin_init() — Method in class simple_fields
Stuff that is being runned only when in admin (i.e.
simple_fields::admin_footer() — Method in class simple_fields
Output HTML for dialog in bottom
simple_fields::admin_head() — Method in class simple_fields
Head of admin area - Add meta box with info about currently selected connector + options to choose another one - Add meta boxes with field groups
simple_fields::admin_head_select_file() — Method in class simple_fields
File browser dialog: hide some things there to make it more clean and user friendly
simple_fields::admin_menu() — Method in class simple_fields
Add the admin menu page for simple fields If you want to hide this for some reason (maybe you are a theme developer that want to use simple fields, but not show the options page to your users) you can add a filter like this:
simple_fields_field_date_v2::action_admin_head() — Method in class simple_fields_field_date_v2
Output CSS in admin head
simple_fields_field_divider::action_admin_head() — Method in class simple_fields_field_divider
Output CSS in admin head
simple_fields_options_page_import_export::ajax_get_export() — Method in class simple_fields_options_page_import_export

B

BasicTest

C

class_simple_fields_debug_panel
Class to extend Debug Bar with groovy Simple Fields stuff
simple_fields::check_upgrade_stuff() — Method in class simple_fields
simple_fields::clear_caches() — Method in class simple_fields
Clear the key used for wpcacheget and wpcacheset Run this when options etc have been changed so fresh values are fetched upon next get

D

$Simple_Fields_Walker_Category_ChecklistProperty in class Simple_Fields_Walker_Category_Checklist
simple_fields::debug_panel_insert() — Method in class simple_fields
Inserts debug panel to debug bar Called form debug bar filter "debugbarpanels", so will only be run'ed when debug bar is activated
simple_fields::debug() — Method in class simple_fields
If setting debug = true then output some debug stuff a little here and there Hopefully this saves us some vardump/sfd/echo all the time usage: first set DEBUGENABLED = true in beginning of class then: simplefields("Saved post connector", array("description" => $value, "description n" => $value_n));
$simple_fields_fieldProperty in class simple_fields_field
$simple_fields_field_exampleProperty in class simple_fields_field_example

E

Simple_Fields_Walker_Category_Checklist::end_lvl() — Method in class Simple_Fields_Walker_Category_Checklist
Simple_Fields_Walker_Category_Checklist::end_el() — Method in class Simple_Fields_Walker_Category_Checklist
simple_fields::edit_post_side_field_settings() — Method in class simple_fields
meta box in sidebar in post edit screen let user select post connector to use for current post
simple_fields_field::edit_output() — Method in class simple_fields_field
Output fields and stuff on post edit page This is the output a regular user will see
simple_fields_field::edit_save() — Method in class simple_fields_field
Called when saving fields, i.e.
simple_fields_field_date_v2::enqueue_scripts() — Method in class simple_fields_field_date_v2
Load scripts and styles
simple_fields_field_date_v2::edit_output() — Method in class simple_fields_field_date_v2
Output datepicker and timepicker on post edit screen
simple_fields_field_date_v2::edit_save() — Method in class simple_fields_field_date_v2
Change so saved value is a single one, instead of array, so we can sort by the unixtime in wp_query etc.
simple_fields_field_divider::edit_output() — Method in class simple_fields_field_divider
Output fields and stuff on post edit page This is the output a regular user will see
simple_fields_field_example::edit_output() — Method in class simple_fields_field_example
Output fields and stuff on post edit page This is the output a regular user will see
simple_fields_field_minimalexample::edit_output() — Method in class simple_fields_field_minimalexample
Output fields and stuff on post edit page This is the output a regular user will see

F

simple_fields::field_type_post_dialog_load() — Method in class simple_fields
Field type: post Fetch content for field type post dialog via AJAX Used for field type post Called from ajax with action wpajaxsimplefieldsfieldtypepostdialogload Ajax defined in scripts.js -> $("a.simple-fields-metabox-field-post-select")
simple_fields::field_group_add_field_template() — Method in class simple_fields
Returns the output for a new or existing field with all it's options Used in options screen / admin screen
simple_fields::field_group_add_field() — Method in class simple_fields
Called from AJAX call to add a field group to the post in edit
simple_fields::field_type_is_core() — Method in class simple_fields
Check if field type with key $strfieldtype is one of the core ones
$simple_fields_fieldProperty in class simple_fields_field

G

simple_fields::get_string() — Method in class simple_fields
Get maybe translated string If WPML is installed and activated then icl_t() is used on the string If WPML is not installed, then it's just returned unmodified
simple_fields::get_slug_pattern() — Method in class simple_fields
Gets the pattern that are allowed for slugs
simple_fields::get_slug_title() — Method in class simple_fields
Get the title for a slug I.e.
simple_fields::get_connector_by_id() — Method in class simple_fields
Returns a post connector
simple_fields::get_post_connector_attached_types() — Method in class simple_fields
Return an array of the post types that we have set up post connectors for
simple_fields::get_default_connector_for_post_type() — Method in class simple_fields
Get default connector for a post type If no connector has been set, none is returned
simple_fields::get_post_connectors() — Method in class simple_fields
Returns all defined post connectors
simple_fields::get_post_type_defaults() — Method in class simple_fields
Returns
simple_fields::get_field_groups() — Method in class simple_fields
Returns all defined field groups
simple_fields::get_field_group() — Method in class simple_fields
Get a field group
simple_fields::get_field_in_group() — Method in class simple_fields
Returns a field from a field group
simple_fields::get_selected_connector_for_post() — Method in class simple_fields
get selected post connector for a post a post has a post connector, or no connector this function will return the inherited connector if post is set to inherit connector unless it's the top most post since then nere are no more to inherit should not return be none then?
simple_fields::get_post_connector_by_slug() — Method in class simple_fields
Get post connector by its slug
simple_fields::get_pages() — Method in class simple_fields
Code from Admin Menu Tree Page View
simple_fields::get_post_connectors_for_post_type() — Method in class simple_fields
Gets the post connectors for a post type
simple_fields::get_options() — Method in class simple_fields
Get all options
simple_fields::get_extended_return_values_for_field() — Method in class simple_fields
Retrieve and return extended return values for a field type Only used for internal/built in file types.
simple_fields::get_field_group_by_slug() — Method in class simple_fields
Gets a field group using it's slug.
simple_fields::get_meta_key_num_added() — Method in class simple_fields
Get meta key name for the custom field used for determine how many fields that has been added to a post hm...
simple_fields::get_meta_key() — Method in class simple_fields
Get meta key name for a field id + field group id combination
simple_fields::get_field_by_slug() — Method in class simple_fields
Returns a field from a fieldgroup using their slugs
simple_fields::get_core_field_type_by_key() — Method in class simple_fields
simple_fields::get_core_field_types() — Method in class simple_fields
Get a list of all core field types Core = all field types that are not extensions Core field types use old and less smart way of storing options
simple_fields::get_html_text_types() — Method in class simple_fields
Get the html input types that we show in text field type
simple_fields::get_options_nav_tabs() — Method in class simple_fields
Get tabs for options output
simple_fields::get_field_by_fieldgroup_and_slug_string() — Method in class simple_fields
Retrive a field by a string in the format / used when fieldgroups and fields need to be passed as string
simple_fields::get_post_connector_from_template() — Method in class simple_fields
simple_fields_field::get_options_id() — Method in class simple_fields_field
Get the id to use in input or label or similiar to be used in options screen
simple_fields_field::get_options_name() — Method in class simple_fields_field
Get the name to use in input or label or similiar to be used in options screen
simple_fields_field::get_class_name() — Method in class simple_fields_field
Return a classname prefixed with simple fields and our field type, to be used in edit post screen Use this to generate class names to make sure they don't collide with other class names in WordPress (from other plugins for example)
simple_fields_options_page_debug::get_name() — Method in class simple_fields_options_page_debug
Get name of this options page tab
simple_fields_options_page_import_export::get_name() — Method in class simple_fields_options_page_import_export
Get name of this options page tab
simple_fields_options_page_import_export::get_export() — Method in class simple_fields_options_page_import_export

H

simple_fields::hijack_thickbox_text() — Method in class simple_fields

I

BasicTest::insertDataForManualAddedFields() — Method in class BasicTest
class_simple_fields_debug_panel::is_visible() — Method in class class_simple_fields_debug_panel
simple_fields::init() — Method in class simple_fields
Init is where we setup actions and filers and loads stuff and a little bit of this and that
simple_fields::is_wpml_active() — Method in class simple_fields
Check if wpml is active
simple_fields_options_page_debug::init() — Method in class simple_fields_options_page_debug
simple_fields_options_page_import_export::init() — Method in class simple_fields_options_page_import_export

K

$simple_fields_fieldProperty in class simple_fields_field
$simple_fields_field_date_v2Property in class simple_fields_field_date_v2
$simple_fields_field_dividerProperty in class simple_fields_field_divider
$simple_fields_field_exampleProperty in class simple_fields_field_example
$simple_fields_field_minimalexampleProperty in class simple_fields_field_minimalexample

M

MyPluginTest
MyPlugin Tests
simple_fields::metabox_fieldgroup_add() — Method in class simple_fields
adds a fieldgroup through ajax = also fetch defaults called when clicking "+ add" in post edit screen
simple_fields::meta_box_output_one_field_group() — Method in class simple_fields
Output the html for a field group in the meta box on the post edit screen Also called from ajax when clicking "+ add"
simple_fields::meta_box_output() — Method in class simple_fields
print out fields for a meta box
simple_fields::media_send_to_editor() — Method in class simple_fields
used from file selector popup send the selected file to simple fields
simple_fields::media_upload_form_url() — Method in class simple_fields
if we have simple fields args in GET, make sure our simple fields-stuff are added to the form
simple_fields::media_upload_tabs() — Method in class simple_fields
remove gallery and remote url tab in file select also remove some
simple_fields::maybe_add_debug_info() — Method in class simple_fields
If debug option is enabled then output debug-box by hooking onto the_content
simple_fields_options_page_import_export::maybe_do_import() — Method in class simple_fields_options_page_import_export
simple_fields_options_page_import_export::maybe_download_export_file() — Method in class simple_fields_options_page_import_export
Check if export file should be downloaded, and if so send headers and the actual json contents

N

$simple_fieldsProperty in class simple_fields
simple_fields::normalize_fieldgroups() — Method in class simple_fields
Make sure a field group has the correct format It can be wrong because prior to version ?.? the options for a field was not stored in the options array.
$simple_fields_fieldProperty in class simple_fields_field
$simple_fields_field_date_v2Property in class simple_fields_field_date_v2
$simple_fields_field_dividerProperty in class simple_fields_field_divider
$simple_fields_field_exampleProperty in class simple_fields_field_example
$simple_fields_field_minimalexampleProperty in class simple_fields_field_minimalexample

O

simple_fields::options_page() — Method in class simple_fields
Output all stuff for the options page
simple_fields::options_page_save() — Method in class simple_fields
simple_fields_field::options_output() — Method in class simple_fields_field
Output on options screen
simple_fields_field::options_save() — Method in class simple_fields_field
simple_fields_field_date_v2::options_output() — Method in class simple_fields_field_date_v2
Output options for the date field We use jquery ui date picker, so we should be able to customize it a bit
simple_fields_field_divider::options_output() — Method in class simple_fields_field_divider
Output on options screen
simple_fields_field_example::options_output() — Method in class simple_fields_field_example
Output on options screen
simple_fields_field_minimalexample::options_output() — Method in class simple_fields_field_minimalexample
Output on options screen
simple_fields_options_page_debug::output_scripts_and_styles() — Method in class simple_fields_options_page_debug
simple_fields_options_page_debug::output_page() — Method in class simple_fields_options_page_debug
Output contents for this options page
simple_fields_options_page_import_export::output_scripts_and_styles() — Method in class simple_fields_options_page_import_export
simple_fields_options_page_import_export::output_page() — Method in class simple_fields_options_page_import_export
Output contents for this options page

P

$BasicTestProperty in class BasicTest
class_simple_fields_debug_panel::prerender() — Method in class class_simple_fields_debug_panel
$simple_fieldsProperty in class simple_fields
simple_fields::plugins_loaded() — Method in class simple_fields
When all plugins have loaded = simple fields has also loaded = safe to add custom field types
simple_fields::post_dbx_post_sidebar() — Method in class simple_fields
output nonce
simple_fields::post_admin_init() — Method in class simple_fields
In file dialog: Change "insert into post" to something better
simple_fields::promote_ep_on_nav_tabs() — Method in class simple_fields
Promote Earth People
simple_fields::post_has_template_connector() — Method in class simple_fields
Returns true if post has a template connector defined
simple_fields_options_page_debug::print_nav_tab() — Method in class simple_fields_options_page_debug
Print the tab for this tab
simple_fields_options_page_import_export::print_nav_tab() — Method in class simple_fields_options_page_import_export
Print the tab for this tab

R

class_simple_fields_debug_panel::render() — Method in class class_simple_fields_debug_panel
$simple_fieldsProperty in class simple_fields
simple_fields::register_wpml_strings() — Method in class simple_fields
Register strings so they are translateable with WPML
simple_fields_field::return_values() — Method in class simple_fields_field
Possibly modify values before returning them Used from functions simplefieldsvalue and simplefieldsvalues $values is an array beginning at 0, for each field, so loop to change all your values (there are several if using repeatable)
simple_fields_field_date_v2::return_values() — Method in class simple_fields_field_date_v2
Add Extended Return Values and then return the values
simple_fields_field_example::return_values() — Method in class simple_fields_field_example
Possibly modify values before returning them Used from functions simplefieldsvalue and simplefieldsvalues $values is an array beginning at 0, for each field, so loop to change all your values (there are several if using repeatable)

S

MyPluginTest::setUp() — Method in class MyPluginTest
SimpleFields_TestCase
$SimpleFields_TestCaseProperty in class SimpleFields_TestCase
SimpleFields_TestCase::setUpBeforeClass() — Method in class SimpleFields_TestCase
Simple_Fields_Walker_Category_Checklist
Simple_Fields_Walker_Category_Checklist::start_lvl() — Method in class Simple_Fields_Walker_Category_Checklist
Simple_Fields_Walker_Category_Checklist::start_el() — Method in class Simple_Fields_Walker_Category_Checklist
simple_fields
Class to keep all simple fields stuff together a bit better
simple_fields::setup_wpml_support() — Method in class simple_fields
Init support for WPML translations
simple_fields::settings_admin_head() — Method in class simple_fields
Run action if we are on a settings/options page that belongs to Simple Fields
simple_fields::set_plugin_row_meta() — Method in class simple_fields
Add settings link to plugin page Hopefully this helps some people to find the settings page quicker
simple_fields::save_postdata() — Method in class simple_fields
Saves simple fields data when post is being saved
simple_fields::save_options() — Method in class simple_fields
Save options
simple_fields::simple_fields_content_debug_output() — Method in class simple_fields
Outputs the names of the post connectors attached to the post you view + outputs the values
simple_fields::set_post_connector_from_template() — Method in class simple_fields
Look for post connector defined in template Format in template is:
simple_fields_field
Class that represents a Simple Fields Field Extend this class to add your own fields.
simple_fields_field::set_options_base_id() — Method in class simple_fields_field
Sets the base for the generation of input ids in options screen Called by options screen.
simple_fields_field::set_options_base_name() — Method in class simple_fields_field
Sets the base for the generation of input names in options screen Called by options screen.
simple_fields_field_date_v2
simple_fields_field_divider
simple_fields_field_example
simple_fields_field_minimalexample
simple_fields_options_page_debug
Simple FIelds options page for import and export
$simple_fields_options_page_debugProperty in class simple_fields_options_page_debug
$simple_fields_options_page_debugProperty in class simple_fields_options_page_debug
simple_fields_options_page_debug::save_debug_options() — Method in class simple_fields_options_page_debug
Save options for debug
simple_fields_options_page_import_export
Simple FIelds options page for import and export
$simple_fields_options_page_import_exportProperty in class simple_fields_options_page_import_export
$simple_fields_options_page_import_exportProperty in class simple_fields_options_page_import_export

T

BasicTest::testSetupCorrectly() — Method in class BasicTest
BasicTest::testCache() — Method in class BasicTest
BasicTest::testDefaultValues() — Method in class BasicTest
BasicTest::testDebug() — Method in class BasicTest
BasicTest::testDebug2() — Method in class BasicTest
BasicTest::testManuallyAddedFields() — Method in class BasicTest
BasicTest::testManuallyAddedFieldsExtendedReturn() — Method in class BasicTest
BasicTest::testPostConnectors() — Method in class BasicTest
BasicTest::testSaveGetOptions() — Method in class BasicTest
BasicTest::testGetAllForPost() — Method in class BasicTest
test simplefieldsgetallfieldsandvaluesforpost() that gets all values for a post simplefieldsgetallfieldsandvaluesforpost
BasicTest::testRegisterFunctions() — Method in class BasicTest
BasicTest::test_meta_key_generator() — Method in class BasicTest
BasicTest::test_misc() — Method in class BasicTest
MyPluginTest::testDefaults() — Method in class MyPluginTest
MyPluginTest::testDebug() — Method in class MyPluginTest
MyPluginTest::testDebug2() — Method in class MyPluginTest
MyPluginTest::testInsertManuallyAddedFields() — Method in class MyPluginTest
MyPluginTest::testManuallyAddedFields() — Method in class MyPluginTest
MyPluginTest::testManuallyAddedFieldsExtendedReturn() — Method in class MyPluginTest
MyPluginTest::testPostConnectors() — Method in class MyPluginTest
MyPluginTest::testSaveGetOptions() — Method in class MyPluginTest
MyPluginTest::testGetAllForPost() — Method in class MyPluginTest
MyPluginTest::testRegisterFunctions() — Method in class MyPluginTest
MyPluginTest::test_misc() — Method in class MyPluginTest
$Simple_Fields_Walker_Category_ChecklistProperty in class Simple_Fields_Walker_Category_Checklist
class_simple_fields_debug_panel::title() — Method in class class_simple_fields_debug_panel

W

WP_PHPUnit_TextUI_Command
A child class of the PHP test runner.
simple_fields::wp_kses() — Method in class simple_fields
Filters content and keeps only allowable HTML elements.

_

WP_PHPUnit_TextUI_Command::__construct() — Method in class WP_PHPUnit_TextUI_Command
simple_fields::_register_field_type() — Method in class simple_fields
simple_fields_field::__construct() — Method in class simple_fields_field
simple_fields_field_date_v2::__construct() — Method in class simple_fields_field_date_v2
simple_fields_field_divider::__construct() — Method in class simple_fields_field_divider
simple_fields_field_example::__construct() — Method in class simple_fields_field_example
simple_fields_field_minimalexample::__construct() — Method in class simple_fields_field_minimalexample
simple_fields_options_page_debug::__construct() — Method in class simple_fields_options_page_debug
simple_fields_options_page_import_export::__construct() — Method in class simple_fields_options_page_import_export