<!--
{
  "availability" : [
    "iOS: 2.0.0 -",
    "iPadOS: 2.0.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 10.0.0 -",
    "tvOS: 9.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Foundation",
  "identifier" : "/documentation/Foundation/UserDefaults/bool(forKey:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "Foundation"
    ],
    "preciseIdentifier" : "c:objc(cs)NSUserDefaults(im)boolForKey:"
  },
  "title" : "bool(forKey:)"
}
-->

# bool(forKey:)

Returns the Boolean value associated with the specified key.

```
func bool(forKey defaultName: String) -> Bool
```

## Parameters

`defaultName`

The key to retrieve from the defaults database.

## Return Value

The Boolean value associated with `defaultName`, or `false` if the key isn’t
present in the defaults database.

## Discussion

This method automatically coerces certain values to their equivalent Boolean meanings.
For example, it coerces the numbers `1` and `1.0`, and the strings “true”, “YES”, and “1” to the value `true`.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)