aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md')
-rw-r--r--vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md
new file mode 100644
index 000000000..a7c920e14
--- /dev/null
+++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-get-registered-object.md
@@ -0,0 +1,36 @@
+getRegisteredObject()
+
+returns a reference to a registered object
+
+Description
+===========
+
+array
+
+getRegisteredObject
+
+string
+
+object\_name
+
+This is useful from within a custom function when you need direct access
+to a [registered object](#api.register.object). See the
+[objects](#advanced.features.objects) page for more info.
+
+
+ <?php
+ function smarty_block_foo($params, $smarty)
+ {
+ if (isset($params['object'])) {
+ // get reference to registered object
+ $obj_ref = $smarty->getRegisteredObject($params['object']);
+ // use $obj_ref is now a reference to the object
+ }
+ }
+ ?>
+
+
+
+See also [`registerObject()`](#api.register.object),
+[`unregisterObject()`](#api.unregister.object) and [objects
+page](#advanced.features.objects)