Secure Custom Fields

https://github.com/wordpress/secure-custom-fields
Admin
Secure Custom Fields is a WordPress plugin that enables developers to take full control of edit...
Tokens:95,181
Snippets:1,166
Trust Score:9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Development Environment Setup and Build Commands

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/AGENTS.md

Commands for installing dependencies, managing the wp-env environment, and building assets.

```bash
# Setup
npm install && composer install
npm run wp-env status   # Always check status first
npm run wp-env start    # Only start if not already running

# Development
npm run watch           # Development with watch
npm run build          # Production build
```

--------------------------------

### Install dependencies with composer i

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/welcome/installation.md

Alternative shorthand command to install dependencies, equivalent to composer install.

```shell
composer i
```

--------------------------------

### Install dependencies and build the plugin

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/index.md

Run these commands in the repository root to install npm and Composer dependencies and build the plugin assets. After this, the checkout is a working plugin with compiled assets in assets/build.

```sh
npm install
composer install
npm run build
```

--------------------------------

### Create a distribution zip

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/index.md

Run this script from a clean git working directory to produce the same zip that gets published on WordPress.org. It verifies required files, installs production-only Composer dependencies, and creates release/secure-custom-fields.zip.

```sh
./bin/create-release-zip.sh
```

--------------------------------

### Install dependencies with composer install

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/welcome/installation.md

Run this command in your terminal to install the dependencies defined in composer.json.

```shell
composer install
```

--------------------------------

### acf_get_ui_options_page_post()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Gets a post object for an SCF UI options page.

```APIDOC
## `acf_get_ui_options_page_post()`

### Description
Gets a post object for an SCF UI options page.

### Parameters
- **$id** (integer|string) - Required - The post ID, key, or name.

### Return Value
- (object|boolean) The post object, or false on failure.
```

--------------------------------

### acf_switch_stores()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Triggered when switching between sites on a multisite installation. Handles store switching.

```APIDOC
## acf_switch_stores()

### Description
Triggered when switching between sites on a multisite installation.

### Parameters
- **$site_id** (integer) - Required - New blog ID.
- **$prev_blog_id** (int) - Required - Prev blog ID.

### Return Value
- **void**
```

--------------------------------

### acf_is_beta()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-helper-functions-file.md

Check if ACF is a beta-like release. This function returns true if the current install version contains a dash, indicating an alpha, beta, or RC release.

```APIDOC
## acf_is_beta()

### Description
Check if ACF is a beta-like release.

### Method
Function

### Parameters
None

### Return Value
- boolean - True if the current install version contains a dash, indicating an alpha, beta or RC release.
```

--------------------------------

### acf_shortcode()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-template-file.md

Adds basic shortcode support for the ACF plugin. Example usage: [acf field="heading" post_id="123" format_value="1"].

```APIDOC
## acf_shortcode()

### Description
Adds basic shortcode support for the ACF plugin. Example usage: [acf field="heading" post_id="123" format_value="1"].

### Parameters
- **$atts** (array) - Required - The shortcode attributes.

### Return Value
string|void
```

--------------------------------

### Configure composer.json for Secure Custom Fields

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/welcome/installation.md

Add this configuration to your composer.json to declare the WPackagist repository, set installer paths for WordPress plugins, require the secure-custom-fields plugin version ^6.4, and allow the composer/installers plugin.

```json
{
  "repositories": [
    {
      "type": "composer",
      "url": "https://wpackagist.org"
    }
  ],
  "extra": {
    "installer-paths": {
      "vendor/{$name}/": ["type:wordpress-plugin"]
    }
  },
  "require": {
    "wpackagist-plugin/secure-custom-fields": "^6.4"
  },
  "config": {
    "allow-plugins": {
      "composer/installers": true
    }
  }
}
```

--------------------------------

### Create release branch and run composer prepare-release

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/releases.md

Run these commands from the trunk branch to create a new release branch and execute the interactive release preparation script. The script builds assets, generates documentation, updates translations, commits changes, prompts for the new version number, and optionally updates the stable tag and creates a PR.

```sh
git checkout trunk && git pull
git checkout -b release/x.y.z
composer prepare-release
```

--------------------------------

### acf_get_metadata_by_field()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-meta-functions-file.md

Gets metadata from the database.

```APIDOC
## Function: acf_get_metadata_by_field()

### Description
Gets metadata from the database.

### Parameters
- **$post_id** (integer|string) - Required - The post id.
- **$field** (array) - Required - The field array.
- **$hidden** (boolean) - Optional - True if we should return the reference key.

### Return Value
- **mixed** - The metadata value.

```

--------------------------------

### Changelog entry format in readme.txt

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/releases.md

Ensure the changelog entry for the new version exists in readme.txt before running the prepare-release script. The format includes a heading with the version and bullet points for features and fixes.

```md
== Changelog ==

= X.Y.Z =
* Feature: Description of new feature
* Fix: Description of bug fix
```

--------------------------------

### acf_get_post_type()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-post-type-functions-file.md

Get an ACF CPT as an array.

```APIDOC
## `acf_get_post_type()`

### Description
Get an ACF CPT as an array.

### Parameters
- **$id** (integer|string) - Required - The post ID being queried.

### Returns
- (array|false) - The post type object.
```

--------------------------------

### acf_prepare_ui_options_page_for_import()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Prepares an ACF UI options page for the import process.

```APIDOC
## `acf_prepare_ui_options_page_for_import()`

### Description
Prepares an ACF UI options page for the import process.

### Parameters
- **$ui_options_page** (array) - Required - The ACF UI options page array.

### Return Value
- (array)
```

--------------------------------

### acf_get_pro_field_types()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/fields-file.md

Get the PRO only fields and their core metadata.

```APIDOC
## `acf_get_pro_field_types()`

### Description
Get the PRO only fields and their core metadata.

### Method
Function

### Parameters
None

### Return
array An array of all the pro field types and their field type selection required meta data.

```

--------------------------------

### Create new SVN tag locally

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/releases.md

After preparing the trunk folder in the SVN repo, copy trunk to tags/x.y.z to create the new tag locally. Replace x.y.z with the version being released.

```sh
svn cp trunk tags/x.y.z
```

--------------------------------

### acf_get_post_type_post()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-post-type-functions-file.md

Gets a post object for an ACF CPT.

```APIDOC
## `acf_get_post_type_post()`

### Description
Gets a post object for an ACF CPT.

### Parameters
- **$id** (integer|string) - Required - The post ID, key, or name.

### Returns
- (object|boolean) - The post object, or false on failure.
```

--------------------------------

### acf_get_validation_error()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/validation-file.md

Gets a specific validation error for an input element.

```APIDOC
## `acf_get_validation_error()`

### Description
Get the validation error.

### Method
Function

### Parameters
- **$input** (string) - Required - Name attribute of DOM element.

### Return Value
string|bool

```

--------------------------------

### Check out SVN repository

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/releases.md

Use this command to create a local checkout of the secure-custom-fields plugin from the WordPress.org SVN repository into a directory named secure-custom-fields-svn.

```sh
svn co https://plugins.svn.wordpress.org/secure-custom-fields secure-custom-fields-svn
```

--------------------------------

### acf_get_raw_ui_options_pages()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Returns an array of raw SCF UI options pages.

```APIDOC
## `acf_get_raw_ui_options_pages()`

### Description
Returns an array of raw SCF UI options pages.

### Parameters
None.

### Return Value
- (array)
```

--------------------------------

### Testing and Code Quality Commands

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/AGENTS.md

Commands for running PHPUnit, PHPStan, Jest, Playwright E2E tests, and code quality tools like linting and formatting.

```bash
# PHP (requires wp-env)
composer test             # All PHP tests (PHPUnit + PHPStan)
composer test:php         # PHPUnit tests only
composer test:php -- --filter=<TestName>  # Specific test
vendor/bin/phpunit <path_to_test_file.php>  # Specific file
vendor/bin/phpunit <path_to_test_directory>/              # Directory
composer test:phpstan     # Static analysis only

# JavaScript unit tests
npm run test:unit         # Jest unit tests
npm run test:unit:watch   # Jest in watch mode

# End-to-end tests (Playwright, requires wp-env)
# IMPORTANT: NEVER run `npx playwright test` directly — always use these npm scripts:
npm run test:e2e                               # All E2E tests
npm run test:e2e:debug                         # Debug mode
npm run test:e2e -- --headed                   # Run with browser visible
npm run test:e2e -- <path_to_test_file.spec.js>  # Specific test file

# Code Quality
npx wp-scripts lint-js    # Check JavaScript linting
npx wp-scripts format     # Fix JavaScript formatting
composer lint:php         # Check PHP standards (phpcs)
composer format:php       # Fix PHP standards (phpcbf)

# Specific files
vendor/bin/phpcs <path_to_php_file.php>   # Check specific file
vendor/bin/phpcbf <path_to_php_file.php>  # Fix specific file
```

--------------------------------

### acf_render_field_instructions()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-field-functions-file.md

Renders the field's instructions. This function outputs the instructions for the field.

```APIDOC
## acf_render_field_instructions()

### Description
Renders the field's instructions.

### Parameters
- **$field** (array) - Required - The field array.
- **$tooltip** (boolean) - Optional - If the instructions are being rendered as a tooltip.

### Return Value
void
```

--------------------------------

### acf_get_pretty_user_roles()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Function to get pretty user roles, though description is not provided.

```APIDOC
## `acf_get_pretty_user_roles()`

### Description
Description not provided in source.

### Parameters
- **$post_id** (int) - Required - The post ID.

### Returns
- (int) - The post ID.

```

--------------------------------

### acf_get_form_data()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-form-functions-file.md

Gets data about the current form. This function retrieves the stored form data for the given store name.

```APIDOC
## acf_get_form_data()

### Description
Gets data about the current form.

### Method
Function

### Signature
`acf_get_form_data( string $name )`

### Parameters
- **$name** (string) - Required - The store name.

### Return Value
- **mixed** - The stored data.

### Example
```php
$data = acf_get_form_data( 'my_form' );
```
```

--------------------------------

### acf_debug_start()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Legacy debugging function, deprecated and always returns false.

```APIDOC
## `acf_debug_start()`

### Description
A legacy function designed for developer debugging. Deprecated since ACF 6.2.6 for security, but the definition is kept for third-party compatibility.

### Return Value
- (false) - Always returns false.
```

--------------------------------

### acf_prepare_ui_options_page_for_export()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Returns a modified ACF UI options page ready for export.

```APIDOC
## `acf_prepare_ui_options_page_for_export()`

### Description
Returns a modified ACF UI options page ready for export.

### Parameters
- **$ui_options_page** (array) - Required - The ACF UI options page array.

### Return Value
- (array)
```

--------------------------------

### ACF_Repeater_Table Class

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/fields/class-acf-repeater-table-file.md

The ACF_Repeater_Table class is a helper for rendering repeater tables. It includes methods for setup, rendering, and handling rows and actions.

```APIDOC
## ACF_Repeater_Table

### Description
Helper class for rendering repeater tables.

### Properties

- **$field** (array) - The main field array used to render the repeater.
- **$sub_fields** (array) - An array containing the subfields used in the repeater.
- **$value** (array) - The value(s) of the repeater field.
- **$show_add** (boolean) - If we should show the "Add Row" button.
- **$show_remove** (boolean) - If we should show the "Remove Row" button.
- **$show_order** (boolean) - If we should show the order of the fields.

### Methods

#### `__construct`

Constructs the ACF_Repeater_Table class.

- **Parameters**:
  - `$field` (array) - The main field array for the repeater being rendered.

#### `setup`

Sets up the field for rendering.

- **Since**: ACF 6.0.0
- **Returns**: void

#### `prepare_value`

Prepares the repeater values for rendering.

- **Since**: ACF 6.0.0
- **Returns**: array

#### `render`

Renders the full repeater table.

- **Since**: ACF 6.0.0
- **Returns**: void

#### `thead`

Renders the table head.

- **Since**: ACF 6.0.0
- **Returns**: void

#### `rows`

Renders or returns rows for the repeater field table.

- **Since**: ACF 6.0.0
- **Parameters**:
  - `$should_return` (boolean) - If we should return the rows or render them.
- **Returns**: array|void

#### `row`

Renders an individual row.

- **Since**: ACF 6.0.0
- **Parameters**:
  - `$i` (integer) - The row number.
  - `$row` (array) - An array containing the row values.
  - `$should_return` (boolean) - If we should return the row or render it.
- **Returns**: string|void

#### `row_handle`

Renders the row handle at the start of each row.

- **Since**: ACF 6.0.0
- **Parameters**:
  - `$i` (integer) - The current row number.
- **Returns**: void

#### `row_actions`

Renders the actions displayed at the end of each row.

- **Since**: ACF 6.0.0
- **Returns**: void

#### `table_actions`

Renders the actions displayed underneath the table.

- **Since**: ACF 6.0.0
- **Returns**: void

#### `pagination`

Renders the table pagination. Mostly lifted from the WordPress core WP_List_Table class.

- **Since**: ACF 6.0.0
- **Returns**: void
```

--------------------------------

### acf_get_raw_ui_options_page()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Retrieves a raw SCF UI options page by post ID.

```APIDOC
## `acf_get_raw_ui_options_page()`

### Description
Retrieves a raw SCF UI options page.

### Parameters
- **$id** (integer|string) - Required - The post ID.

### Return Value
- (array|false) The UI options page array.
```

--------------------------------

### acf_new_instance()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Creates a new instance of the given class and stores it in the instances data store. Returns the created instance.

```APIDOC
## acf_new_instance()

### Description
Creates a new instance of the given class and stores it in the instances data store.

### Parameters
- **$class** (string) - Required - The class name.

### Return Value
- **object** - The instance.
```

--------------------------------

### acf_prepare_block()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/blocks-file.md

Prepares a block for use in render_callback by merging in all settings and attributes.

```APIDOC
## acf_prepare_block()

### Description
Prepares a block for use in render_callback by merging in all settings and attributes.

### Parameters
- **$block** (array) - Required - The block props.

### Return Value
(array|boolean)
```

--------------------------------

### Retrieve Options Page Value: get_option('phone_number')

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/tutorials/first-options-page.md

Used in classic themes to retrieve a field value stored on an options page. The example fetches the company phone number field and outputs it using echo.

```php
<?php
$phone_number = get_option('phone_number');
echo $phone_number;
?>
```

--------------------------------

### acf_get_path()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Returns the plugin path to a specified file. Provides the absolute filesystem path.

```APIDOC
## acf_get_path()

### Description
Returns the plugin path to a specified file.

### Parameters
- **$filename** (string) - Required - The specified file.

### Return Value
- **string** - The plugin path.
```

--------------------------------

### _scf_prepare_bidirectional_update()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-bidirectional-functions-file.md

Prepares a side-effect-free bidirectional update plan. This function is marked as internal.

```APIDOC
## `_scf_prepare_bidirectional_update()`

### Description
Prepare a side-effect-free bidirectional update plan.

### Parameters
- **$target_item_ids** (array) - Required - Target post, user, or term IDs.
- **$post_id** (integer|string) - Required - Encoded origin object ID.
- **$field** (array) - Required - Field being updated on the origin object.
- **$target_prefix** (string|false) - Required - Target object prefix, or false for posts.
- **$current_values** (array|null) - Optional - Optional current raw field values.

### Return Value
- array

### Since
SCF 6.9.5

### Internal
This function is marked as @internal.
```

--------------------------------

### acf_get_local_store()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/local-fields-file.md

Returns the local store or a dummy store for the given name or post type.

```APIDOC
## `acf_get_local_store()`

### Description
Returns either local store or a dummy store for the given name or post type.

### Method
Function

### Signature
`acf_get_local_store( $name, $post_type )`

### Parameters
- **$name** (string) - Required - The store name.
- **$post_type** (string) - Required - The post type for the desired store.

### Return Value
ACF_Data
```

--------------------------------

### acf_init()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Alias of acf()->init() - the core ACF init function. This function initializes the ACF plugin.

```APIDOC
## `acf_init()`

### Description
Alias of acf()->init() - the core ACF init function.

### Method
Function call

### Parameters
None

### Return Value
n/a
```

--------------------------------

### acf_get_ui_options_pages()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Returns an array of SCF UI options pages filtered by given arguments.

```APIDOC
## `acf_get_ui_options_pages()`

### Description
Returns an array of SCF UI options pages for the given $filter.

### Parameters
- **$filter** (array) - Required - An array of args to filter results by.

### Return Value
- (array)
```

--------------------------------

### acf_prepare_internal_post_type_for_import()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-internal-post-type-functions-file.md

Prepares an ACF post for the import process.

```APIDOC
## `acf_prepare_internal_post_type_for_import()`

### Description
Prepares an ACF post for the import process.

### Method
Function

### Signature
`acf_prepare_internal_post_type_for_import( array $post, string $post_type )`

### Parameters
- **$post** (array) - Required - The ACF post array.
- **$post_type** (string) - Required - The post type of the ACF post being imported.

### Return
- **array** - The prepared post array.

### Since
ACF 6.1
```

--------------------------------

### acf_prepare_field()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-field-functions-file.md

Prepares a field for input.

```APIDOC
## `acf_prepare_field()`

### Description
Prepares a field for input.

### Method
Function

### Signature
`acf_prepare_field( $field )`

### Parameters
- **$field** (array) - Required - The field array.

### Return Value
- **array** - The prepared field.
```

--------------------------------

### acf_import_ui_options_page()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Imports an ACF UI options page into the database.

```APIDOC
## `acf_import_ui_options_page()`

### Description
Imports an ACF UI options page into the database.

### Parameters
- **$ui_options_page** (array) - Required - The ACF UI options page array.

### Return Value
- (array) The imported options page.
```

--------------------------------

### acf_translate_ui_options_page()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Translates the settings for an SCF UI options page.

```APIDOC
## `acf_translate_ui_options_page()`

### Description
Translates the settings for an SCF UI options page.

### Parameters
- **$ui_options_page** (array) - Required - The SCF UI options page array.

### Return Value
- (array)
```

--------------------------------

### acf_render_field_wrap_description()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/deprecated-file.md

Renders the field's instructions. Deprecated since ACF 5.6.5.

```APIDOC
## `acf_render_field_wrap_description()`

### Description
Renders the field's instructions.

### Parameters
- **$field** (array) - Required - The field array.

### Return Value
void

### Deprecated
Since ACF 5.6.5
```

--------------------------------

### acf_match_location_rule()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/locations-file.md

Returns true if the provided rule matches the screen args.

```APIDOC
## `acf_match_location_rule()`

### Description
Returns true if the provided rule matches the screen args.

### Parameters
- **$rule** (array) - Required - The location rule.
- **$screen** (array) - Required - The screen args.
- **$field_group** (array) - Required - The field group array.

### Return Value
- boolean
```

--------------------------------

### acf_process_block_toolbar_fields()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/blocks-file.md

Prepares a fields array for being localized and used on the frontend as block toolbar fields. Accepts a list of fields, each can be a string or an associative array with specific keys.

```APIDOC
## Function: acf_process_block_toolbar_fields()

### Description
Prepares a fields array for being localized and used on the frontend as block toolbar fields.

### Parameters
- **$fields** (array) - Required - A list of the fields, each of which will be displayed in the popup toolbar. Each field can be passed as one of the following:
  - A string (e.g. 'my_field_name')
  - An associative array with specific keys:
    - **$field_name** (string) - The name of the field to display in the toolbar.
    - **$field_icon** (string) - An html tag, can be an svg, to be used as the toolbar icon. If not passed, the icon of the first field will be used.
    - **$field_label** (string) - A string to use as the label for the button in the toolbar.

### Return Value
- (array) The array of fields, prepared for JS localization.
```

--------------------------------

### acf_register_store()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Registers a data store with the given name and optional initial data. Returns the ACF_Data store object.

```APIDOC
## acf_register_store()

### Description
Registers a data store.

### Parameters
- **$name** (string) - Required - The store name.
- **$data** (array) - Optional - Array of data to start the store with.

### Return Value
- **ACF_Data** - The registered data store.
```

--------------------------------

### acf_get_ui_options_page()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Retrieves an SCF UI options page as an array by its post ID.

```APIDOC
## `acf_get_ui_options_page()`

### Description
Get an SCF UI options page as an array.

### Parameters
- **$id** (integer|string) - Required - The post ID being queried.

### Return Value
- (array|false) The UI options page array.
```

--------------------------------

### acf_get_version_when_first_activated()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-helper-functions-file.md

Returns the version of ACF when it was first activated. If ACF was first activated prior to the introduction of the acf_first_activated_version option, this function returns false.

```APIDOC
## acf_get_version_when_first_activated()

### Description
Returns the version of ACF when it was first activated. However, if ACF was first activated prior to the introduction of the acf_first_activated_version option, this function returns false (boolean) to indicate that the version could not be determined.

### Method
Function

### Parameters
None

### Return Value
- string|boolean - The (string) version of ACF when it was first activated, or false (boolean) if the version could not be determined.
```

--------------------------------

### acf_prepare_post_type_for_import()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-post-type-functions-file.md

Prepares an ACF post type for the import process.

```APIDOC
## `acf_prepare_post_type_for_import()`

### Description
Prepares an ACF post type for the import process.

### Parameters
- **$post_type** (array) - Required - The ACF post type array.

### Returns
- (array)
```

--------------------------------

### acf_file_input()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

Renders the HTML of a file input.

```APIDOC
## acf_file_input()

### Description
Renders the HTML of a file input.

### Parameters
- **$attrs** (array) - Required - The array of attrs.

### Return Value
- (void) - Echos out value.
```

--------------------------------

### acf_get_location_screen()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/locations-file.md

Returns an array of screen args to be used against matching rules.

```APIDOC
## `acf_get_location_screen()`

### Description
Returns an array of screen args to be used against matching rules.

### Parameters
- **$screen** (array) - Required - The screen args.
- **$deprecated** (array) - Required - Deprecated.

### Return Value
- array
```

--------------------------------

### acf_get_sites()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Returns an array of sites for a network.

```APIDOC
## `acf_get_sites()`

### Description
Returns an array of sites for a network.

### Method
Function call

### Endpoint
`acf_get_sites()`

### Parameters
None

### Response
#### Success Response
- **Return** (array) - An array of sites for a network.

### Response Example
```php
$sites = acf_get_sites();
```
```

--------------------------------

### acf_get_pretty_taxonomies()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-term-file.md

Deprecated in favor of acf_get_taxonomy_labels(). No parameters documented.

```APIDOC
## Function: acf_get_pretty_taxonomies()

### Description
Deprecated in favor of acf_get_taxonomy_labels() function.

### Deprecated
Since ACF 5.7.2
```

--------------------------------

### acf_get_store()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Returns a data store by name. Retrieves an existing registered data store.

```APIDOC
## acf_get_store()

### Description
Returns a data store.

### Parameters
- **$name** (string) - Required - The store name.

### Return Value
- **ACF_Data** - The data store.
```

--------------------------------

### acf_get_instance()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Returns an instance for the given class. Retrieves an existing instance from the data store.

```APIDOC
## acf_get_instance()

### Description
Returns an instance for the given class.

### Parameters
- **$class** (string) - Required - The class name.

### Return Value
- **object** - The instance.
```

--------------------------------

### acf_export_ui_options_page_as_php()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Exports an ACF UI options page as PHP.

```APIDOC
## `acf_export_ui_options_page_as_php()`

### Description
Exports an ACF UI options page as PHP.

### Parameters
- **$ui_options_page** (array) - Required - The ACF UI options page array.

### Return Value
- (string|boolean)
```

--------------------------------

### acf_format_filesize()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Returns a formatted string containing the filesize and unit.

```APIDOC
## acf_format_filesize()

### Description
Returns a formatted string containing the filesize and unit.

### Parameters
- **$size** (mixed) - Required - The filesize value to format.

### Return
(int) - The formatted filesize string.
```

--------------------------------

### acf_get_bidirectional_field_settings_instruction_text()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-bidirectional-functions-file.md

Returns the translated instructional text for the message field for the bidirectional field settings.

```APIDOC
## `acf_get_bidirectional_field_settings_instruction_text()`

### Description
Returns the translated instructional text for the message field for the bidirectional field settings.

### Parameters
None

### Return Value
- string - The html containing the instructional message.

### Since
ACF 6.2
```

--------------------------------

### acf_textarea_input()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

Renders the HTML of a textarea input.

```APIDOC
## acf_textarea_input()

### Description
Renders the HTML of a textarea input.

### Parameters
- **$attrs** (array) - Required - The array of attrs.

### Return Value
- (void) - Echos out value.
```

--------------------------------

### Add Composer autoloader in plugin or theme

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/welcome/installation.md

Add this line to your plugin or theme to load Composer dependencies automatically.

```php
require_once plugin_dir_path(dirname(__FILE__)) . 'vendor/autoload.php';
```

--------------------------------

### acf_get_option_meta()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-meta-functions-file.md

Returns an array of meta for the given wp_option name prefix in the same format as get_post_meta().

```APIDOC
## Function: acf_get_option_meta()

### Description
Returns an array of meta for the given wp_option name prefix in the same format as get_post_meta().

### Parameters
- **$prefix** (string) - Required - The wp_option name prefix.

### Return Value
- **array** - The meta data.

```

--------------------------------

### acf_handle_json_block_registration()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/blocks-file.md

Handles an SCF block registered through block.json. Takes compiled block settings and raw JSON metadata, and returns block registration settings with ACF required additions.

```APIDOC
## Function: acf_handle_json_block_registration()

### Description
Handle an SCF block registered through block.json.

### Parameters
- **$settings** (array) - Required - The compiled block settings.
- **$metadata** (array) - Required - The raw json metadata.

### Return Value
- (array) Block registration settings with ACF required additions.

### Since
ACF 6.0.0
```

--------------------------------

### acf_walk_select_input()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

Returns the HTML of a select input's choices.

```APIDOC
## acf_walk_select_input()

### Description
Returns the HTML of a select input's choices.

### Parameters
- **$choices** (array) - Required - The choices to walk through.
- **$values** (array) - Required - The selected choices.
- **$depth** (array) - Required - The current walk depth.

### Return Value
- (string) - The HTML of the choices.
```

--------------------------------

### Load Secure Custom Fields plugin manually

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/welcome/installation.md

Use this code to manually load the Secure Custom Fields plugin and define its paths. Adjust MY_SCF_PATH and MY_SCF_URL to match your plugin/theme structure.

```php
if (! class_exists('ACF')) {
    // Define the path and URL to the Secure Custom Fields plugin.
    define('MY_SCF_PATH', plugin_dir_path(dirname(__FILE__)) . 'vendor/secure-custom-fields/');
    define('MY_SCF_URL', plugin_dir_url(dirname(__FILE__)) . 'vendor/secure-custom-fields/');

    // Include the plugin main file.
    require_once MY_SCF_PATH . 'secure-custom-fields.php';
}
```

--------------------------------

### acf_get_full_version()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Removes beta or RC suffixes from a version string.

```APIDOC
## `acf_get_full_version()`

### Description
This function will remove any '-beta1' or '-RC1' strings from a version.

### Parameters
- **$version** (string) - Required - The version string to clean.

### Return
(string) - The cleaned version string.
```

--------------------------------

### acf_raw_setting()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Retrieves a setting value by name.

```APIDOC
## `acf_raw_setting()`

### Description
Alias of acf()->get_setting(). Retrieves a setting value.

### Parameters
- **$name** (string) - Name of the setting to retrieve.

### Return Value
- **mixed** - The setting value.

```

--------------------------------

### acf_is_screen()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Checks if all arguments match the current screen and returns true if they do.

```APIDOC
## `acf_is_screen()`

### Description
This function will return true if all args are matched for the current screen.

### Parameters
- **$post_id** (int) - Required - The post ID.

### Return Value
- (int) - The post ID.

```

--------------------------------

### acf_text_input()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

Renders the HTML of a text input.

```APIDOC
## acf_text_input()

### Description
Renders the HTML of a text input.

### Parameters
- **$attrs** (array) - Required - The array of attrs.

### Return Value
- (void) - Echos out value.
```

--------------------------------

### acf_get_file_input()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

Returns the HTML of a file input.

```APIDOC
## acf_get_file_input()

### Description
Returns the HTML of a file input.

### Parameters
- **$attrs** (array) - Required - The array of attrs.

### Return Value
- (string) - The HTML of the file input.
```

--------------------------------

### acf_untrash_ui_options_page()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Restores an ACF UI options page from the trash.

```APIDOC
## `acf_untrash_ui_options_page()`

### Description
Restores an ACF UI options page from the trash.

### Parameters
- **$id** (integer|string) - Required - The UI options page ID, key, or name.

### Return Value
- (boolean) True if the options page was untrashed.
```

--------------------------------

### acf_is_ui_options_page()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/scf-ui-options-page-functions-file.md

Checks if given parameters match an ACF UI options page.

```APIDOC
## `acf_is_ui_options_page()`

### Description
Returns true if the given params match an ACF UI options page.

### Parameters
- **$ui_options_page** (array) - Required - The ACF UI options page array.

### Return Value
- (boolean)
```

--------------------------------

### acf_get_view()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Loads a file from the 'admin/views' folder and allows variables to be passed through. Useful for rendering admin views.

```APIDOC
## `acf_get_view()`

### Description
Loads a file from the 'admin/views' folder and allows variables to be passed through.

### Method
Function

### Signature
`acf_get_view( string $view_path, array $view_args )`

### Parameters
- **$view_path** (string) - Required - The path to the view file.
- **$view_args** (array) - Required - Variables to pass to the view.

### Return Value
None

### Since
ACF 5.0.0
```

--------------------------------

### acf_get_compatibility()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/compatibility-file.md

Returns true if compatibility is enabled for the given component. This function is used to check the compatibility status of a specific component.

```APIDOC
## acf_get_compatibility()

### Description
Returns true if compatibility is enabled for the given component.

### Method
Function

### Signature
acf_get_compatibility( string $name ) : boolean

### Parameters
- **$name** (string) - Required - The name of the component to check.

### Return Value
- (boolean) - True if compatibility is enabled, false otherwise.

### Example
```php
$is_compatible = acf_get_compatibility( 'my_component' );
```
```

--------------------------------

### acf_request_args()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-helper-functions-file.md

Returns an array of $_REQUEST values using the provided defaults.

```APIDOC
## `acf_request_args()`

### Description
Returns an array of $_REQUEST values using the provided defaults.

### Parameters
- **$args** (array) - Required - An array of args.

### Return Value
- (array) - An array of request values.
```

--------------------------------

### acf_upload_files()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Walks through the $_FILES data and uploads each file found.

```APIDOC
## `acf_upload_files()`

### Description
This function will walk through the $_FILES data and upload each found.

### Parameters
- **$ancestors** (array) - Optional - An internal parameter, not required.

```

--------------------------------

### acf_esc_atts()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

See acf_esc_attrs().

```APIDOC
## acf_esc_atts()

### Description
See acf_esc_attrs().

### Parameters
- **$attrs** (array) - Required - The array of attrs.

### Return Value
- (string) - The escaped attrs.
```

--------------------------------

### acf_get_image_sizes()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/api/api-helpers-file.md

Retrieves the list of available image sizes.

```APIDOC
## `acf_get_image_sizes()`

### Description
Returns an array of available image sizes.

### Parameters
- n/a

### Returns
- (array) An array of available image sizes.

### Since
ACF 5.0.0
```

--------------------------------

### acf_select_input()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-input-functions-file.md

Renders the HTML of a select input.

```APIDOC
## acf_select_input()

### Description
Renders the HTML of a select input.

### Parameters
- **$attrs** (array) - Required - The array of attrs.

### Return Value
- (void) - No return value.
```

--------------------------------

### acf_include()

Source: https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/code-reference/acf-utility-functions-file.md

Includes a file within the ACF plugin. Loads the specified file.

```APIDOC
## acf_include()

### Description
Includes a file within the ACF plugin.

### Parameters
- **$filename** (string) - Required - The specified file.

### Return Value
- **void**
```
Tokens:
Raw