SunshinePHP 2019

The MongoDB\BSON\ObjectId class

(mongodb >=1.0.0)


BSON type for an » ObjectId. The value consists of 12 bytes, where the first four bytes are a timestamp that reflect the ObjectId's creation. Specifically, the value consists of:

  • a 4-byte value representing the seconds since the Unix epoch,
  • a 3-byte machine identifier,
  • a 2-byte process ID, and
  • a 3-byte counter, starting with a random value.

In MongoDB, each document stored in a collection requires a unique _id field that acts as a primary key. If an inserted document omits the _id field, the driver automatically generates an ObjectId for the _id field.

Using ObjectIds for the _id field provides the following additional benefits:

  • The creation time of the ObjectId may be accessed using the MongoDB\BSON\ObjectId::getTimestamp() method.
  • Sorting on an _id field that stores ObjectId values is roughly equivalent to sorting by creation time.

Class synopsis

final MongoDB\BSON\ObjectId implements MongoDB\BSON\ObjectIdInterface , MongoDB\BSON\Type , Serializable , JsonSerializable {
/* Methods */
final public __construct ([ string $id ] )
final public int getTimestamp ( void )
final public mixed jsonSerialize ( void )
final public string serialize ( void )
final public string __toString ( void )
final public void unserialize ( string $serialized )


Version Description

Renamed from MongoDB\BSON\ObjectID to MongoDB\BSON\ObjectId.

1.2.0 Implements Serializable and JsonSerializable.

Table of Contents

add a note add a note

User Contributed Notes 2 notes

naip1984 at gmail dot com
11 months ago
I struggled for awhile to identify the way to find() using a ObjectID

This seems to work, I hope this helps someone else out. 

$mongoId = '5a2493c33c95a1281836eb6a';

$collection->find(['_id'=> new MongoDB\BSON\ObjectId("$mongoId")]);

I found it here:

Note this is for the PHP library, not the legacy library.
Mike T
6 months ago
Worth noting this will throw an InvalidArgumentException if string is not in the correct format
To Top