From a22ec8cbfa5ec424cce751e194943328a16c1eec Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 4 Jul 2014 20:34:34 -0700 Subject: doc updates --- doc/html/plugin_8php.html | 129 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 125 insertions(+), 4 deletions(-) (limited to 'doc/html/plugin_8php.html') diff --git a/doc/html/plugin_8php.html b/doc/html/plugin_8php.html index 66df95ed7..822d746ba 100644 --- a/doc/html/plugin_8php.html +++ b/doc/html/plugin_8php.html @@ -109,24 +109,33 @@ $(document).ready(function(){initNavTree('plugin_8php.html','');});
plugin.php File Reference
+ +

Some functions to handle addons and themes. +More...

+ + + + + + @@ -135,8 +144,10 @@ Functions + + @@ -151,6 +162,7 @@ Functions + @@ -177,7 +189,9 @@ Functions

Functions

 unload_plugin ($plugin)
 unloads an addon. More...
 
 uninstall_plugin ($plugin)
 uninstalls an addon. More...
 
 install_plugin ($plugin)
 installs an addon. More...
 
 load_plugin ($plugin)
 loads an addon by it's name. More...
 
 plugin_is_installed ($name)
 
 reload_plugins ()
 
 register_hook ($hook, $file, $function, $priority=0)
 registers a hook. More...
 
 unregister_hook ($hook, $file, $function)
 unregisters a hook. More...
 
 load_hooks ()
 
 call_hooks ($name, &$data=null)
 
 get_plugin_info ($plugin)
 parse plugin comment in search of plugin infos. More...
 
 get_theme_info ($theme)
 parse theme comment in search of theme infos. More...
 
 get_theme_screenshot ($theme)
 
 upgrade_bool_message ($bbcode=false)
 
 head_add_css ($src, $media= 'screen')
 add CSS to <head> More...
 
 head_remove_css ($src, $media= 'screen')
 
 get_markup_template ($s, $root= '')
 
-

Function Documentation

+

Detailed Description

+

Some functions to handle addons and themes.

+

Function Documentation

@@ -202,7 +216,7 @@ Functions
-

Referenced by _well_known_init(), api_login(), atom_author(), atom_entry(), authenticate_success(), avatar_img(), bb2diaspora(), bbcode(), channel_remove(), chat_message(), chatsvc_post(), check_account_email(), check_account_invite(), check_account_password(), connect_content(), connections_post(), connedit_content(), connedit_post(), construct_page(), contact_block(), contact_select(), conversation(), create_identity(), cronhooks_run(), directory_content(), downgrade_accounts(), drop_item(), editblock_content(), editlayout_content(), editpost_content(), editwebpage_content(), event_store_item(), externals_run(), feature_enabled(), gender_selector(), get_all_perms(), get_atom_elements(), get_features(), get_feed_for(), get_mood_verbs(), get_perms(), get_poke_verbs(), Item\get_template_data(), App\get_widgets(), group_select(), home_content(), home_init(), hostxrd_init(), html2bbcode(), import_author_xchan(), import_directory_profile(), import_xchan(), item_photo_menu(), item_post(), item_store(), item_store_update(), like_content(), login(), magic_init(), mail_store(), marital_selector(), mood_init(), nav(), network_content(), network_to_name(), new_contact(), notification(), notifier_run(), obj_verbs(), oembed_fetch_url(), openid_content(), parse_url_content(), pdl_selector(), perm_is_allowed(), photo_upload(), photos_content(), ping_init(), poller_run(), populate_acl(), post_activity_item(), post_init(), prepare_body(), probe_well_known(), proc_run(), process_delivery(), profile_content(), profile_sidebar(), profiles_content(), profiles_post(), replace_macros(), rmagic_post(), settings_post(), sexpref_selector(), siteinfo_content(), smilies(), subthread_content(), tag_deliver(), validate_channelname(), wfinger_init(), widget_affinity(), xrd_init(), zfinger_init(), zid(), and zid_init().

+

Referenced by _well_known_init(), api_login(), atom_author(), atom_entry(), authenticate_success(), avatar_img(), bb2diaspora(), bbcode(), channel_remove(), chat_message(), chatsvc_post(), check_account_email(), check_account_invite(), check_account_password(), connect_content(), connections_post(), connedit_content(), connedit_post(), construct_page(), contact_block(), contact_select(), conversation(), create_identity(), cronhooks_run(), directory_content(), downgrade_accounts(), drop_item(), editblock_content(), editlayout_content(), editpost_content(), editwebpage_content(), event_store_item(), externals_run(), feature_enabled(), gender_selector(), get_all_perms(), get_atom_elements(), get_features(), get_feed_for(), get_mood_verbs(), get_perms(), get_poke_verbs(), Item\get_template_data(), App\get_widgets(), group_select(), home_content(), home_init(), hostxrd_init(), html2bbcode(), import_author_xchan(), import_directory_profile(), import_xchan(), item_photo_menu(), item_post(), item_store(), item_store_update(), like_content(), login(), magic_init(), mail_store(), marital_selector(), mood_init(), nav(), network_content(), network_to_name(), new_contact(), notification(), notifier_run(), obj_verbs(), oembed_fetch_url(), openid_content(), parse_url_content(), pdl_selector(), perm_is_allowed(), photo_upload(), photos_content(), ping_init(), poller_run(), populate_acl(), post_activity_item(), post_init(), prepare_body(), probe_well_known(), proc_run(), process_delivery(), profile_content(), profile_sidebar(), profiles_content(), profiles_post(), replace_macros(), rmagic_post(), settings_post(), sexpref_selector(), siteinfo_content(), smilies(), subthread_content(), tag_deliver(), validate_channelname(), wfinger_init(), widget_affinity(), xrd_init(), zfinger_init(), zid(), and zid_init().

@@ -266,7 +280,7 @@ Functions
-

Referenced by check_config(), lostpass_content(), lostpass_post(), send_reg_approval_email(), send_verification_email(), setup_post(), and user_allow().

+

Referenced by check_config(), lostpass_content(), lostpass_post(), send_reg_approval_email(), send_verification_email(), setup_post(), user_allow(), and verify_email_address().

@@ -294,7 +308,7 @@ Functions
-

Referenced by admin_content(), admin_page_channels(), admin_page_dbsync(), admin_page_hubloc(), admin_page_logs(), admin_page_plugins(), admin_page_site(), admin_page_summary(), admin_page_themes(), admin_page_users(), advanced_profile(), alt_pager(), api_apply_template(), api_content(), app_render(), appman_content(), apps_content(), apw_form(), blocks_content(), blogtheme_form(), App\build_pagehead(), categories_widget(), channel_content(), chat_content(), check_php(), common_content(), common_friends_visitor_widget(), connect_content(), connections_content(), connedit_content(), construct_page(), contact_block(), conversation(), delegate_content(), design_tools(), dir_safe_mode(), dir_sort_links(), directory_content(), dirprofile_init(), display_content(), editblock_content(), editlayout_content(), editpost_content(), editwebpage_content(), events_content(), fbrowser_content(), field_timezone(), fileas_widget(), filer_content(), filestorage_content(), findpeople_widget(), format_categories(), format_filer(), RedBrowser\generateDirectoryIndex(), get_birthdays(), Item\get_comment_box(), get_events(), get_feed_for(), group_content(), group_side(), help_content(), hostxrd_init(), identity_selector(), import_content(), invite_content(), lang_selector(), layouts_content(), login(), lostpass_content(), mail_content(), manage_content(), match_content(), menu_content(), menu_render(), message_content(), micropro(), mini_group_select(), mitem_content(), mood_content(), nav(), network_content(), new_channel_content(), notification(), notifications_content(), notify_content(), oembed_format_object(), oexchange_init(), opensearch_init(), pagelist_widget(), pdledit_content(), photos_album_widget(), photos_content(), poco_init(), poke_content(), populate_acl(), profile_sidebar(), profiles_content(), rbmark_content(), redbasic_form(), register_content(), removeme_content(), rmagic_content(), rpost_content(), search_content(), setup_content(), siteinfo_content(), sources_content(), suggest_content(), theme_attachments(), thing_content(), vcard_from_xchan(), viewconnections_content(), vote_content(), webpages_content(), widget_affinity(), widget_appselect(), widget_archive(), widget_bookmarkedchats(), widget_chatroom_list(), widget_filer(), widget_follow(), widget_mailmenu(), widget_notes(), widget_savedsearch(), widget_settings_menu(), widget_suggestedchats(), widget_suggestions(), writepages_widget(), and xrd_init().

+

Referenced by admin_content(), admin_page_channels(), admin_page_dbsync(), admin_page_hubloc(), admin_page_logs(), admin_page_plugins(), admin_page_site(), admin_page_summary(), admin_page_themes(), admin_page_users(), advanced_profile(), alt_pager(), api_apply_template(), api_content(), app_render(), appman_content(), apps_content(), apw_form(), blocks_content(), blogtheme_form(), App\build_pagehead(), categories_widget(), channel_content(), chat_content(), check_php(), common_content(), common_friends_visitor_widget(), connect_content(), connections_content(), connedit_content(), construct_page(), contact_block(), conversation(), delegate_content(), design_tools(), dir_safe_mode(), dir_sort_links(), directory_content(), dirprofile_init(), display_content(), editblock_content(), editlayout_content(), editpost_content(), editwebpage_content(), events_content(), fbrowser_content(), field_timezone(), fileas_widget(), filer_content(), filestorage_content(), findpeople_widget(), format_categories(), format_filer(), RedBrowser\generateDirectoryIndex(), get_birthdays(), Item\get_comment_box(), get_events(), get_feed_for(), group_content(), group_side(), help_content(), hostxrd_init(), RedBrowser\htmlActionsPanel(), identity_selector(), import_content(), invite_content(), lang_selector(), layouts_content(), login(), lostpass_content(), mail_content(), manage_content(), match_content(), menu_content(), menu_render(), message_content(), micropro(), mini_group_select(), mitem_content(), mood_content(), nav(), network_content(), new_channel_content(), notification(), notifications_content(), notify_content(), oembed_format_object(), oexchange_init(), opensearch_init(), pagelist_widget(), pdledit_content(), photos_album_widget(), photos_content(), poco_init(), poke_content(), populate_acl(), profile_sidebar(), profiles_content(), rbmark_content(), redbasic_form(), register_content(), removeme_content(), rmagic_content(), rpost_content(), search_content(), setup_content(), siteinfo_content(), sources_content(), suggest_content(), theme_attachments(), thing_content(), vcard_from_xchan(), viewconnections_content(), vote_content(), webpages_content(), widget_affinity(), widget_appselect(), widget_archive(), widget_bookmarkedchats(), widget_chatroom_list(), widget_filer(), widget_follow(), widget_mailmenu(), widget_notes(), widget_savedsearch(), widget_settings_menu(), widget_suggestedchats(), widget_suggestions(), writepages_widget(), and xrd_init().

@@ -312,6 +326,25 @@ Functions
+

parse plugin comment in search of plugin infos.

+

like

+ +

Referenced by admin_page_plugins().

@@ -330,6 +363,25 @@ Functions
+

parse theme comment in search of theme infos.

+

like

+ +

Referenced by admin_page_themes(), and pretheme_init().

@@ -376,6 +428,16 @@ Functions
+

add CSS to <head>

+
Parameters
+ + + +
string$src
string$mediachange media attribute (default to 'screen')
+
+
+
Returns
void
+

Referenced by construct_page().

@@ -541,6 +603,15 @@ Functions
+

installs an addon.

+
Parameters
+ + +
string$pluginname of the addon
+
+
+
Returns
bool
+

Referenced by admin_page_plugins().

@@ -576,6 +647,15 @@ Functions
+

loads an addon by it's name.

+
Parameters
+ + +
string$pluginname of the addon
+
+
+
Returns
bool
+

Referenced by check_config(), and install_plugin().

@@ -634,6 +714,18 @@ Functions
+

registers a hook.

+
Parameters
+ + + + + +
string$hookthe name of the hook
string$filethe name of the file that hooks into
string$functionthe name of the function that the hook will call
int$priorityA priority (defaults to 0)
+
+
+
Returns
mixed|bool
+

Referenced by blog_install().

@@ -776,6 +868,15 @@ Functions
+

uninstalls an addon.

+
Parameters
+ + +
string$pluginname of the addon
+
+
+
Returns
bool
+

Referenced by admin_page_plugins().

@@ -794,6 +895,15 @@ Functions
+

unloads an addon.

+
Parameters
+ + +
string$pluginname of the addon
+
+
+
Returns
void
+

Referenced by check_config(), and uninstall_plugin().

@@ -828,6 +938,17 @@ Functions
+

unregisters a hook.

+
Parameters
+ + + + +
string$hookthe name of the hook
string$filethe name of the file that hooks into
string$functionthe name of the function that the hook called
+
+
+
Returns
mixed
+

Referenced by blog_uninstall().

-- cgit v1.2.3