WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

maybe_serialize()

maybe_serialize( string|array|object $data ): mixed

In this article

Back to top

Serializes data, if needed.

Parameters

$datastring|array|objectrequired
Data that might be serialized.

Return

mixed A scalar data.

More Information

  • Data might need to be serialized to allow it to be successfully stored and retrieved from a database in a form that PHP can understand.
  • Confusingly, strings that contain already serialized values are serialized again, resulting in a nested serialization. Other strings are unmodified.
  • A possible solution to prevent nested serialization is to check if a variable is serialized using is_serialized() 
if( !is_serialized( $data ) ) {
$data = maybe_serialize($data);
}

Source

function maybe_serialize( $data ) {
	if ( is_array( $data ) || is_object( $data ) ) {
		return serialize( $data );
	}

	/*
	 * Double serialization is required for backward compatibility.
	 * See https://core.trac.wordpress.org/ticket/12930
	 * Also the world will end. See WP 3.6.1.
	 */
	if ( is_serialized( $data, false ) ) {
		return serialize( $data );
	}

	return $data;
}

View all references View on Trac View on GitHub

UsesDescription
is_serialized()wp-includes/functions.php

Checks value to find if it was serialized.

Used byDescription
WP_Site_Health::get_autoloaded_options_size()wp-admin/includes/class-wp-site-health.php

Calculates total amount of autoloaded data.

WP_Customize_Manager::import_theme_starter_content()wp-includes/class-wp-customize-manager.php

Imports theme starter content into the customized state.

update_network_option()wp-includes/option.php

Updates the value of a network option that was already added.

add_network_option()wp-includes/option.php

Adds a new network option.

populate_options()wp-admin/includes/schema.php

Create WordPress options and set the default values.

update_usermeta()wp-includes/deprecated.php

Update metadata of user.

update_option()wp-includes/option.php

Updates the value of an option that was already added.

add_option()wp-includes/option.php

Adds a new option.

delete_metadata()wp-includes/meta.php

Deletes metadata for the specified object.

update_metadata_by_mid()wp-includes/meta.php

Updates metadata by meta ID.

add_metadata()wp-includes/meta.php

Adds metadata for the specified object.

update_metadata()wp-includes/meta.php

Updates metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.

Show 7 moreShow less

Changelog

VersionDescription
2.0.5Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    Basic Examples

    <?php

// Strings are returned untouched.
$data = 'Hello World!';
echo maybe_serialize( $data );
// Hello World!

// Integers, floats and boolean values are also returned untouched.
$data = 55;
echo maybe_serialize( $data );
// 55

$data = 4.560
echo maybe_serialize( $data );
// 4.560

$data = true;
$data = maybe_serialize( $data );
// $data = true;

$data = null;
$data = maybe_serialize( $data );
// $data = null

// An array or object will be returned as a serialized string.
$data = array( 1 => 'Hello World!', 'foo' => 'bar' );
echo maybe_serialize( $data );
// a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";}

// A serialized string will be serialized again.
$data = 'a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";}';
echo maybe_serialize( $data );
// s:50:"a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";}";

?>

You must log in before being able to contribute a note or feedback.