Docs Menu

Docs HomePHP Library Manual

MongoDB\UpdateResult::getModifiedCount()

On this page

  • Definition
  • Return Values
  • Errors/Exceptions
  • See Also
MongoDB\UpdateResult::getModifiedCount()

Return the number of documents that were modified.

function getModifiedCount(): integer|null

This method should only be called if the write was acknowledged.

Note

If an update/replace operation results in no change to the document (e.g. setting the value of a field to its current value), the modified count may be less than the value returned by getMatchedCount().

The number of documents that were modified.

MongoDB\Exception\BadMethodCallException if this method is called and the write operation used an unacknowledged write concern.

← MongoDB\UpdateResult::getMatchedCount()