<?php
/**
* @package ACF
* @author WP Engine
*
* © 2025 Advanced Custom Fields (ACF®). All rights reserved.
* "ACF" is a trademark of WP Engine.
* Licensed under the GNU General Public License v2 or later.
* https://www.gnu.org/licenses/gpl-2.0.html
*/
/**
* acf_has_upgrade
*
* Returns true if this site has an upgrade avaialble.
*
* @date 24/8/18
* @since 5.7.4
*
* @param void
* @return boolean
*/
function acf_has_upgrade() {
$db_version = acf_get_db_version();
if ( $db_version && acf_version_compare( $db_version, '<', ACF_UPGRADE_VERSION ) ) {
return true;
}
if ( $db_version !== ACF_VERSION ) {
acf_update_db_version( ACF_VERSION );
}
return false;
}
/**
* Runs upgrade routines if this site has an upgrade available.
*
* @date 24/8/18
* @since 5.7.4
*/
function acf_upgrade_all() {
// Increase time limit if possible.
if ( function_exists( 'set_time_limit' ) ) {
set_time_limit( 600 );
}
// start timer
timer_start();
// log
acf_dev_log( 'ACF Upgrade Begin.' );
// vars
$db_version = acf_get_db_version();
// 5.0.0
if ( acf_version_compare( $db_version, '<', '5.0.0' ) ) {
acf_upgrade_500();
}
// 5.5.0
if ( acf_version_compare( $db_version, '<', '5.5.0' ) ) {
acf_upgrade_550();
}
/**
* When adding new upgrade routines here, increment the ACF_UPGRADE_VERSION
* constant in `acf.php` to the new highest upgrade version.
*/
// upgrade DB version once all updates are complete
acf_update_db_version( ACF_VERSION );
if ( is_multisite() ) {
// Clears the network upgrade notification banner after site upgrades.
delete_site_transient( 'acf_network_upgrade_needed_' . ACF_UPGRADE_VERSION );
}
// log
global $wpdb;
acf_dev_log( 'ACF Upgrade Complete.', $wpdb->num_queries, timer_stop( 0 ) );
}
/**
* acf_get_db_version
*
* Returns the ACF DB version.
*
* @date 10/09/2016
* @since 5.4.0
*
* @param void
* @return string
*/
function acf_get_db_version() {
return get_option( 'acf_version' );
}
/**
* Updates the ACF DB version.
*
* @date 10/09/2016
* @since 5.4.0
*
* @param string $version The new version.
* @return void
*/
function acf_update_db_version( $version = '' ) {
update_option( 'acf_version', $version );
}
/**
* acf_upgrade_500
*
* Version 5 introduces new post types for field groups and fields.
*
* @date 23/8/18
* @since 5.7.4
*
* @param void
* @return void
*/
function acf_upgrade_500() {
// log
acf_dev_log( 'ACF Upgrade 5.0.0.' );
// action
do_action( 'acf/upgrade_500' );
// do tasks
acf_upgrade_500_field_groups();
// update version
acf_update_db_version( '5.0.0' );
}
/**
* acf_upgrade_500_field_groups
*
* Upgrades all ACF4 field groups to ACF5
*
* @date 23/8/18
* @since 5.7.4
*
* @param void
* @return void
*/
function acf_upgrade_500_field_groups() {
// log
acf_dev_log( 'ACF Upgrade 5.0.0 Field Groups.' );
// get old field groups
$ofgs = get_posts(
array(
'numberposts' => -1,
'post_type' => 'acf',
'orderby' => 'menu_order title',
'order' => 'asc',
'suppress_filters' => true,
)
);
// loop
if ( $ofgs ) {
foreach ( $ofgs as $ofg ) {
acf_upgrade_500_field_group( $ofg );
}
}
}
/**
* acf_upgrade_500_field_group
*
* Upgrades a ACF4 field group to ACF5
*
* @date 23/8/18
* @since 5.7.4
*
* @param object $ofg The old field group post object.
* @return array $nfg The new field group array.
*/
function acf_upgrade_500_field_group( $ofg ) {
// log
acf_dev_log( 'ACF Upgrade 5.0.0 Field Group.', $ofg );
// vars
$nfg = array(
'ID' => 0,
'title' => $ofg->post_title,
'menu_order' => $ofg->menu_order,
);
// construct the location rules
$rules = get_post_meta( $ofg->ID, 'rule', false );
$anyorall = get_post_meta( $ofg->ID, 'allorany', true );
if ( is_array( $rules ) ) {
// if field group was duplicated, rules may be a serialized string!
$rules = array_map( 'acf_maybe_unserialize', $rules );
// convert rules to groups
$nfg['location'] = acf_convert_rules_to_groups( $rules, $anyorall );
}
// settings
if ( $position = get_post_meta( $ofg->ID, 'position', true ) ) {
$nfg['position'] = $position;
}
if ( $layout = get_post_meta( $ofg->ID, 'layout', true ) ) {
$nfg['layout'] = $layout;
}
if ( $hide_on_screen = get_post_meta( $ofg->ID, 'hide_on_screen', true ) ) {
$nfg['hide_on_screen'] = acf_maybe_unserialize( $hide_on_screen );
}
// save field group
// acf_upgrade_field_group will call the acf_get_valid_field_group function and apply 'compatibility' changes
$nfg = acf_update_field_group( $nfg );
// log
acf_dev_log( '> Complete.', $nfg );
// action for 3rd party
do_action( 'acf/upgrade_500_field_group', $nfg, $ofg );
// upgrade fields
acf_upgrade_500_fields( $ofg, $nfg );
// trash?
if ( $ofg->post_status == 'trash' ) {
acf_trash_field_group( $nfg['ID'] );
}
// return
return $nfg;
}
/**
* acf_upgrade_500_fields
*
* Upgrades all ACF4 fields to ACF5 from a specific field group
*
* @date 23/8/18
* @since 5.7.4
*
* @param object $ofg The old field group post object.
* @param array $nfg The new field group array.
* @return void
*/
function acf_upgrade_500_fields( $ofg, $nfg ) {
// log
acf_dev_log( 'ACF Upgrade 5.0.0 Fields.' );
// global
global $wpdb;
// get field from postmeta
$rows = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d AND meta_key LIKE %s", $ofg->ID, 'field_%' ), ARRAY_A );
// check
if ( $rows ) {
// vars
$checked = array();
// loop
foreach ( $rows as $row ) {
// vars
$field = $row['meta_value'];
$field = acf_maybe_unserialize( $field );
$field = acf_maybe_unserialize( $field ); // run again for WPML
// bail early if key already migrated (potential duplicates in DB)
if ( isset( $checked[ $field['key'] ] ) ) {
continue;
}
$checked[ $field['key'] ] = 1;
// add parent
$field['parent'] = $nfg['ID'];
// migrate field
$field = acf_upgrade_500_field( $field );
}
}
}
/**
* acf_upgrade_500_field
*
* Upgrades a ACF4 field to ACF5
*
* @date 23/8/18
* @since 5.7.4
*
* @param array $field The old field.
* @return array $field The new field.
*/
function acf_upgrade_500_field( $field ) {
// log
acf_dev_log( 'ACF Upgrade 5.0.0 Field.', $field );
// order_no is now menu_order
$field['menu_order'] = acf_extract_var( $field, 'order_no', 0 );
// correct very old field keys (field2 => field_2)
if ( substr( $field['key'], 0, 6 ) !== 'field_' ) {
$field['key'] = 'field_' . str_replace( 'field', '', $field['key'] );
}
// extract sub fields
$sub_fields = array();
if ( $field['type'] == 'repeater' ) {
// loop over sub fields
if ( ! empty( $field['sub_fields'] ) ) {
foreach ( $field['sub_fields'] as $sub_field ) {
$sub_fields[] = $sub_field;
}
}
// remove sub fields from field
unset( $field['sub_fields'] );
} elseif ( $field['type'] == 'flexible_content' ) {
// loop over layouts
if ( is_array( $field['layouts'] ) ) {
foreach ( $field['layouts'] as $i => $layout ) {
// generate key
$layout['key'] = uniqid( 'layout_' );
// loop over sub fields
if ( ! empty( $layout['sub_fields'] ) ) {
foreach ( $layout['sub_fields'] as $sub_field ) {
$sub_field['parent_layout'] = $layout['key'];
$sub_fields[] = $sub_field;
}
}
// remove sub fields from layout
unset( $layout['sub_fields'] );
// update
$field['layouts'][ $i ] = $layout;
}
}
}
// save field
$field = acf_update_field( $field );
// log
acf_dev_log( '> Complete.', $field );
// sub fields
if ( $sub_fields ) {
foreach ( $sub_fields as $sub_field ) {
$sub_field['parent'] = $field['ID'];
acf_upgrade_500_field( $sub_field );
}
}
// action for 3rd party
do_action( 'acf/update_500_field', $field );
// return
return $field;
}
/**
* acf_upgrade_550
*
* Version 5.5 adds support for the wp_termmeta table added in WP 4.4.
*
* @date 23/8/18
* @since 5.7.4
*
* @param void
* @return void
*/
function acf_upgrade_550() {
// log
acf_dev_log( 'ACF Upgrade 5.5.0.' );
// action
do_action( 'acf/upgrade_550' );
// do tasks
acf_upgrade_550_termmeta();
// update version
acf_update_db_version( '5.5.0' );
}
/**
* acf_upgrade_550_termmeta
*
* Upgrades all ACF4 termmeta saved in wp_options to the wp_termmeta table.
*
* @date 23/8/18
* @since 5.7.4
*
* @param void
* @return void
*/
function acf_upgrade_550_termmeta() {
// log
acf_dev_log( 'ACF Upgrade 5.5.0 Termmeta.' );
// bail early if no wp_termmeta table
if ( get_option( 'db_version' ) < 34370 ) {
return;
}
// get all taxonomies
$taxonomies = get_taxonomies( false, 'objects' );
// loop
if ( $taxonomies ) {
foreach ( $taxonomies as $taxonomy ) {
acf_upgrade_550_taxonomy( $taxonomy->name );
}
}
// action for 3rd party
do_action( 'acf/upgrade_550_termmeta' );
}
/**
* When the database is updated to support term meta, migrate ACF term meta data across.
*
* @date 23/8/18
* @since 5.7.4
*
* @param string $wp_db_version The new $wp_db_version.
* @param string $wp_current_db_version The old (current) $wp_db_version.
* @return void
*/
function acf_wp_upgrade_550_termmeta( $wp_db_version, $wp_current_db_version ) {
if ( $wp_db_version >= 34370 && $wp_current_db_version < 34370 ) {
if ( acf_version_compare( acf_get_db_version(), '>', '5.5.0' ) ) {
acf_upgrade_550_termmeta();
}
}
}
add_action( 'wp_upgrade', 'acf_wp_upgrade_550_termmeta', 10, 2 );
/**
* acf_upgrade_550_taxonomy
*
* Upgrades all ACF4 termmeta for a specific taxonomy.
*
* @date 24/8/18
* @since 5.7.4
*
* @param string $taxonomy The taxonomy name.
* @return void
*/
function acf_upgrade_550_taxonomy( $taxonomy ) {
// log
acf_dev_log( 'ACF Upgrade 5.5.0 Taxonomy.', $taxonomy );
// global
global $wpdb;
// vars
$search = $taxonomy . '_%';
$_search = '_' . $search;
// escape '_'
// http://stackoverflow.com/questions/2300285/how-do-i-escape-in-sql-server
$search = str_replace( '_', '\_', $search );
$_search = str_replace( '_', '\_', $_search );
// search
// results show faster query times using 2 LIKE vs 2 wildcards
$rows = $wpdb->get_results(
$wpdb->prepare(
"SELECT *
FROM $wpdb->options
WHERE option_name LIKE %s
OR option_name LIKE %s",
$search,
$_search
),
ARRAY_A
);
// loop
if ( $rows ) {
foreach ( $rows as $row ) {
/**
* Use regex to find "(_)taxonomy_(term_id)_(field_name)" and populate $matches:
* Array
* (
* [0] => _category_3_color
* [1] => _
* [2] => 3
* [3] => color
* )
*/
if ( ! preg_match( "/^(_?){$taxonomy}_(\d+)_(.+)/", is_null( $row['option_name'] ) ? '' : $row['option_name'], $matches ) ) {
continue;
}
// vars
$term_id = $matches[2];
$meta_key = $matches[1] . $matches[3];
$meta_value = $row['option_value'];
// update
// memory usage reduced by 50% by using a manual insert vs update_metadata() function.
// update_metadata( 'term', $term_id, $meta_name, $meta_value );
$wpdb->insert(
$wpdb->termmeta,
array(
'term_id' => $term_id,
'meta_key' => $meta_key,
'meta_value' => $meta_value,
)
);
// log
acf_dev_log( 'ACF Upgrade 5.5.0 Term.', $term_id, $meta_key );
// action
do_action( 'acf/upgrade_550_taxonomy_term', $term_id );
}
}
// action for 3rd party
do_action( 'acf/upgrade_550_taxonomy', $taxonomy );
}
All system for education purposes only. For more tools: Telegram @jackleet