Jump to content

Community

Developer Documentation

Overview of the Extensions system

What is an extension?

One of the fundamental ways of implementing cross-application integration with the IPS4 framework is the concept of extensions. Put simply, an extension is a way for an application to implement specific behavior in specific parts of the suite. For example, there's an extension that allows an application to specify how its content is handled by the search system, and another that allows the application to build elements to be displayed on the "Edit Member" screen in the AdminCP. If your application provides an extension, it will be automatically loaded in the appropriate places.

 

Creating an extension

Extensions are created in the Developer Center for your application in the AdminCP. IPS4 will automatically generate the class file in the appropriate extension directory within your application; you'll be prompted to enter a classname for your extension when creating it.

Each extension requires different methods, depending on what the extension does. Refer to this documentation or the individual source files in the /extensions directory of your application for more information.

 

Types of extension

core

  • AdminNotifications
    Send admin notifications and display banners to administrators
  • AdvertisementLocations
    Create additional locations for advertisements within the application.
  • Announcements
    Provide control over where attachments should display within the application (for example: in which categories).
  • BBCode
    Add a BBCode tag to the parsing engine.
  • Build
    Run custom code when building the application.
  • BulkMail
    Provide additional replacement tags within bulk mails.
  • CommunityEnhancements
    Add third-party APIs and services to the Community Enhancements section of the AdminCP.
  • ContactUs
    Add additional fields to the contact us form and provide control over where submissions to the Contact Us form should be sent
  • ContentModeratorPermissions
    Add content moderator permissions.
  • ContentRouter
    Specify the content items used within the application.
  • CreateMenu
    Add elements to the '+Create' menu which displays in the header of every page.
  • Dashboard
    Add content to the AdminCP Dashboard.
  • DesignersMode
    Run code when designers mode is enabled and disabled.
  • EditorLocations
    Specify the WYSIWYG editor locations used in the application.
  • EditorMedia
    Add additional media sources to the 'Insert existing attachment' button on the editor.
  • FileStorage
    Specify the types of files used by the application
  • FrontNavigation
    Add tabs and menus to the global navigation bar.
  • GroupForm
    Add group settings.
  • GroupLimits
    Control how group settings should be handled for secondary groups.
  • IncomingEmail
    Handle incoming emails.
  • IpAddresses
    Specify areas where IP addresses are logged in the application.
  • LiveSearch
    Add to the AdminCP live search feature.
  • MFAArea
    Define an area to be protected by muti-factor authentication.
  • MemberACPProfileBlocks
    Add a block to the AdminCP member view.
  • MemberACPProfileContentTab
    Add a tab to the Content Statistics block within the AdminCP member view.
  • MemberACPProfileTabs
    Add a tab to the AdminCP member view.
  • MemberExportPersonalInformation
    Add additional data to the personal information XML file.
  • MemberFilter
    Provide ways of filtering members for bulk mail, etc.
  • MemberForm
    Add settings to AdminCP Edit Member form.
  • MemberHistory
    Add data parsers for Member History display
  • MemberRestrictions
    Show content and add fields to the associated form for the Warnings & Restrictions block within the AdminCP member view.
  • MemberSync
    Run code for when a member account is created, edited, merged or deleted.
  • MetaData
    Add content meta data types
  • MobileNavigation
    Add items to the mobile app navigation bar.
  • ModCp
    Add to the ModCP.
  • ModCpMemberManagement
    Add filters to the ModCP member management page.
  • ModeratorPermissions
    Add moderator permissions.
  • Notifications
    Specify the types of notifications sent by the application.
  • OutputPlugins
    Add template tags.
  • OverviewStatistics
    Add a block to the user or activity overview statistics page
  • Permissions
    Specify the nodes with permissions integration used within the application.
  • Profile
    Add content to users' profiles.
  • ProfileSteps
    Suggested steps to complete profiles
  • Queue
    Specify background queue tasks used by the application.
  • RssImport
    Import content from an RSS feed
  • Sitemap
    Add to the sitemap.
  • StreamItems
    Add extra items to activity stream
  • Uninstall
    Run code when an application is uninstalled.

nexus

  • Item
    Sell items with Commerce integration.

  Report Document


×
×
  • Create New...

Important Information

We use technologies, such as cookies, to customise content and advertising, to provide social media features and to analyse traffic to the site. We also share information about your use of our site with our trusted social media, advertising and analytics partners. See more about cookies and our Privacy Policy