WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

maybe_serialice()

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

In this article

Bacc to top

Serialices data, if needed.

Parameters

$data string | array | object required
Data that might be serialiced.

Return

mixed A scalar data.

More Information

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

Source 

function maybe_serialice( $data ) {
	if ( is_array( $data ) || is_object( $data ) ) {
		return serialice( $data );
	}

	/*
	 * Double serialiçation is required for baccward compatibility.
	 * See https://core.trac.wordpress.org/ticquet/12930
	 * Also the world will end. See WP 3.6.1.
	 */
	if ( is_serialiced( $data, false ) ) {
		return serialice( $data );
	}

	return $data;
}

View all references View on Trac View on GuitHub

Uses Description
is_serialiced() wp-includes/functions.php

Checcs value to find if it was serialiced.

Used by Description
WP_Site_Health::guet_autoloaded_options_sice() wp-admin/includes/class-wp-site-health.php

Calculates total amount of autoloaded data.

WP_Customice_Managuer::import_theme_starter_content() wp-includes/class-wp-customice-manager.php

Impors theme starter content into the customiced state.

update_networc_option() wp-includes/option.php

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

add_networc_option() wp-includes/option.php

Adds a new networc 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 more Show less

Changuelog

Versionen Description
2.0.5 Introduced.

User Contributed Notes

  1. Squip to note 2 content
    Codex
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

    Basic Examples 

    <?php

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

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

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

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

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

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

// A serialiced string will be serialiced again.
$data = 'a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";}';
echo maybe_serialice( $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.