|
|
Close Minimize Help | ||||||||||||||
Advanced Custom Fields is a WordPress plugin which allows you to add extra content fields to your WordPress edit screens. These extra content fields are more commonly referred to as Custom Fields and can allow you to build website’s faster and educate your client’s quicker.
ACF boasts a simple to use and powerful API. Checkout the available functions to power your website.
| Basic | |
|---|---|
| get_field() | Returns the value of a specific field. |
| get_field_object() | Returns the settings of a specific field. |
| get_field_objects() | Returns the settings of all fields saved on a specific post. |
| get_fields() | Returns an array of field values (name => value) for a specific post. |
| the_field() | Displays the value of a specific field. |
| Loop | |
|---|---|
| get_row() | Returns an array containing all values for the current row. |
| get_row_index() | Returns the current row index within a have_rows() loop |
| get_row_layout() | Returns the current row layout name within a have_rows() loop |
| get_sub_field() | Returns the value of a specific sub field. |
| get_sub_field_object() | Returns the settings of a specific sub field. |
| have_rows() | Used to loop through a parent field's value. |
| the_sub_field() | Displays the value of a specific sub field. |
| Update | |
|---|---|
| add_row() | Adds a new row of data to an existing Repeater or Flexible Content field value. |
| add_sub_row() | Adds a new row of data to a Repeater or Flexible Content sub field value. |
| delete_field() | Deletes the value of a specific field. |
| delete_row() | Deletes a row of data from an existing Repeater or Flexible Content field value. |
| delete_sub_field() | Deletes the value of a specific sub field. |
| delete_sub_row() | Deletes a row of data from an existing Repeater or Flexible Content sub field value. |
| update_field() | Updates the value of a specific field. |
| update_row() | Updates a row of data for an existing Repeater or Flexible Content field value. |
| update_sub_field() | Updates the value of a specific sub field. |
| update_sub_row() | Updates a row of data for an existing Repeater or Flexible Content sub field value. |
| Other | |
|---|---|
| acf_add_options_page() | Adds an options page to the admin menu. |
| acf_register_block_type() | Registers a custom block type in the Gutenberg editor. |
| acf_add_options_sub_page() | Add a global options sub page to the WP dashboard |
| acf_form_head() | Validates and saves data submitted from an acf_form(). |
| acf_form() | Creates a front end form. |
| acf_register_form() | Registers a front end form. |
| Shortcode | Used within a content editor to display a custom field’s value |
| Deprecated | |
|---|---|
| acf_set_options_page_capability() | |
| acf_set_options_page_menu() | |
| acf_set_options_page_title() | |
| has_sub_field() | |
| the_flexible_field() | |
| the_repeater_field() | |
Hook into these actions to customize your ACF experience.
| acf/save_post | Called when saving $_POST data. |
| acf/field_group/admin_enqueue_scripts | Called during the enqueue_scripts action when editing a field group. |
| acf/field_group/admin_head | Called during the admin_head action when editing a field group |
| acf/init | Called after ACF is finished loading and is similar to the WordPress init action. |
| acf/input/admin_enqueue_scripts | Called during the enqueue_scripts action when editing a post. |
| acf/input/admin_footer | Called during the admin_footer action when editing a post. |
| acf/input/admin_head | Called during the admin_head action when editing a post. |
| acf/input/form_data | Called during the form element when editing a post. |
| acf/render_field | Called when rendering a field input |
| acf/validate_save_post | Called when validating $_POST data. |
| Deprecated | |
|---|---|
| acf_head-fields | |
| acf_head-input | |
| acf_print_scripts-input | |
| acf_print_styles-input | |
| acf_save_post | |
Hook into these actions to customize your ACF experience.
| acf/compatibility | Enable specific backwards compatibility logic |
| acf/fields/flexible_content/layout_title | Customize the text (HTML) displayed at the top of each flexible content layout |
| acf/fields/google_map/api | Customize the URL parameters used to load Google Maps JS |
| acf/fields/post_object/query | Customize the $args array used to query posts for the post object field |
| acf/fields/post_object/result | Customize the result (text) displayed for each option in the post object field |
| acf/fields/relationship/query | Customize the $args array used to query posts for the relationship field |
| acf/fields/relationship/result | Customize the result (text) displayed for each option in the relationship field |
| acf/fields/taxonomy/query | Customize the $args array used to query terms for the taxonomy field (select display) |
| acf/fields/taxonomy/result | Customize the result (text) displayed for each option in the taxonomy field |
| acf/fields/taxonomy/wp_list_categories | Customize the $args array used to query and list terms for the taxonomy field (checkbox and radio display) |
| acf/format_value | Customize the value when it is called from a template function such as get_field() |
| acf/load_field | Customize the field when it is loaded |
| acf/load_value | Customize the value when it is loaded |
| acf/pre_save_post | Customize the $post_id used to save data during the acf_form_head() function |
| acf/prepare_field | Customize the field after its value is loaded (before field is rendered for input) |
| acf/settings | Customize ACF settings which are used throughout the plugin |
| acf/update_value | Customize the value before it is saved |
| acf/upload_prefilter | Perform custom validation on an attachment before it is uploaded |
| acf/validate_attachment | Perform custom validation on an attachment before it is uploaded or selected |
| acf/validate_value | Perform custom validation on a field's value before it is saved |
| Deprecated | |
|---|---|
| acf_load_field | |
| acf_load_value | |
| acf_update_value | |
| acf/options_page/settings | |
We curated an extensive list of frequently asked questions to help you quickly get on with your project.
If you have a question regarding the ACF plugin or the ACF website, please take a look at the FAQ categories here.
