[ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Site API: WP_Site class
File Size: | 352 lines (7 kb) |
Included or required: | 1 time |
Referenced: | 0 times |
Includes or requires: | 0 files |
get_instance( $site_id ) X-Ref |
Retrieves a site from the database by its ID. return: WP_Site|false The site's object if found. False if not. param: int $site_id The ID of the site to retrieve. since: 4.5.0 |
__construct( $site ) X-Ref |
Creates a new WP_Site object. Will populate object properties from the object provided and assign other default properties based on that information. param: WP_Site|object $site A site object. since: 4.5.0 |
to_array() X-Ref |
Converts an object to array. return: array Object as array. since: 4.6.0 |
__get( $key ) X-Ref |
Getter. Allows current multisite naming conventions when getting properties. Allows access to extended site properties. return: mixed Value of the property. Null if not available. param: string $key Property to get. since: 4.6.0 |
__isset( $key ) X-Ref |
Isset-er. Allows current multisite naming conventions when checking for properties. Checks for extended site properties. return: bool Whether the property is set. param: string $key Property to check if set. since: 4.6.0 |
__set( $key, $value ) X-Ref |
Setter. Allows current multisite naming conventions while setting properties. param: string $key Property to set. param: mixed $value Value to assign to the property. since: 4.6.0 |
get_details() X-Ref |
Retrieves the details for this site. This method is used internally to lazy-load the extended properties of a site. return: stdClass A raw site object with all details included. since: 4.6.0 |
Generated: Thu Nov 21 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |