Skip to content

Plugin Development

Have a question about building a plugin? Ask here
423 Topics 1.9k Posts
  • Create custom fields in composer

    4
    0 Votes
    4 Posts
    268 Views
    K

    Hi @Ali-Hussain ,
    Did you ever figure this out?
    I am trying to do something similar by adding a custom field to the post object based on a button I've added to the composer.

  • 1 Votes
    2 Posts
    77 Views
    barisB

    You can modify/override methods on the db object but not sure if it's worth the trouble.

  • Clean way to provide alias for link

    5
    0 Votes
    5 Posts
    89 Views
    Johan WathermanJ

    Ok, looks like I know what I need to know, what's possible, what doesn't make sense, and what could be a workaround.
    Thank you very much.

  • Some question about upload image

    2
    0 Votes
    2 Posts
    68 Views
    barisB

    filter:uploadImage hook receives some params that you can use to differentiate between a profile/cover picture for a user vs an image that is uploaded to a post.

    When a cover or profile image is uploaded the folder passed to the hook is set to profile. Also the image object will have a name field that is set to either profileAvatar or profileCover depending on what is being uploaded. When you upload a image to a post the folder is set to files.

    I think the upload from url is no longer used since that is handled client side now when someone tries to set their profile image from a url. In the past we used to download the image from that url server side but not it is handled client side with the cropper lib.

  • 0 Votes
    2 Posts
    151 Views
    barisB
    Do I understand correctly that I should simply save the collection of X objects like any other data in NodeBB, using its abstract data access mechanisms?

    Yes, just use the db.setObject and other methods available, this ensures your plugin works on redis/psql/mongodb.

    Can I expand the user data, topic, posts, etc. with an additional field in the database (probably containing the id of related X objects so that I can immediately ask about the right objects)?

    Yes, some plugins like QnA do this and add solved/isQuestion fields into the topic objects.

    NodeBB is very flexible in terms of data structure.

  • 0 Votes
    9 Posts
    321 Views
    S

    @julian, I am trying to implement your suggestion.

    @julian said in Share your opinion on my unique user registration process, please?:

    As long as those form fields have name, then it is added to the form data, and sent to the backend.

    So, I would still need to implement some backend code to save this to the user object, right? using the setter here: https://community.nodebb.org/topic/16994/how-do-i-add-custom-user-fields-to-my-theme

    Because, doing db.objects.find({username: "test"}) doesn't include the custom fields.

    @julian said in Share your opinion on my unique user registration process, please?:

    You probably can't see the additional info in the registration queue template, so you may have to modify that one too.

    The API response for /api/admin/manage/registration does not contain the custom fields. Am I doing something wrong, or is this expected? What is the easiest way to add these fields to the API response? Thank you.

  • nodebb-plugin-audioplayer

    16
    4 Votes
    16 Posts
    7k Views
    DownPWD

    UP UP 🙂

    yep very cool to update it for V3 with a possibility to add flac and a playlist or several style of music

  • 0 Votes
    2 Posts
    102 Views
    julianJ

    Most likely all server-side hooks are not specific to users (unless the UID is in the hook name, but I doubt we have any), so you'll have to just do an early-return if the condition doesn't match. It is likely not going to cause issues with the server. There are a thousand things that would need to be optimized before something like this causes a slowdown 🙂

  • 0 Votes
    7 Posts
    210 Views
    julianJ

    @baris perhaps it shouldn't be .btn-primary as it doesn't often get clicked 😄

  • 0 Votes
    4 Posts
    158 Views
    Eduardo SilvaE

    Tks so much, @baris and @julian!

    The await User.setUserField(user.uid, 'picture', user.profile_picture_url) approach worked!

    Yes, @julian, it's listening to the import-users-csv plugin hook.

    As soon as I finish the plugin I'll make a proper post announcing and explaining it.

  • 0 Votes
    3 Posts
    147 Views
    Eduardo SilvaE

    Great, tks!

    Just sent an e-mail :))

  • User avatar occurred error via sso

    1
    0 Votes
    1 Posts
    70 Views
    Sky凌空S

    I write a sso plugin,but when user loading their sso avatar,the error occurred
    屏幕截图 2023-10-14 162931.png
    And the server can get this url.
    This is code screenshot:
    屏幕截图 2023-10-14 154845.png
    How could i fix it?

  • 0 Votes
    1 Posts
    76 Views
    T

    A new question concerning the development of my Backblaze B2 storage plugin:

    I kind of have it working now, where files are uploaded and filenames returned properly, though it's lacking the sophisticated ways of setting host, bucket and credentials as the old s3 plugins (I'm still struggling figuring out what the hooks and functions are available to a plugin developer, since the documentation doesn't seem to be very updated and detailed).

    I noticed there is this button to export personal data, including uploaded files. How should I possibly integrate this functionality into my plugin?

    Thom

  • Convenient way for plugin test

    3
    0 Votes
    3 Posts
    169 Views
    T

    @josef Thank you. I'll give it a try.

  • 0 Votes
    9 Posts
    366 Views
    oplik0O

    @eeeee Probably local to the user computer 🙂

    You can generally use non-http URIs for launching different applications. If you were ever redirected from a desktop or mobile app to a browser to log in you've probably seen this in action. Windows actually uses some internally and usually transparently for the user (for example, to abuse their monopoly, MS started using microsoft-edge: scheme instead of https: in some links in Windows to only allow opening them in Edge. They didn't have to build some highly custom mechanism, just restrict other apps from registering this scheme), but usually can be just registered by applications you install. What they do also depends on the application - for example, I think calculator: only launches the calculator app (or at least the obvious way to write math doesn't work), but others can launch specific actions and even pass some information (for example, authentication token for the web login use case I mentioned). For example Spotify allows linking to artists, playlists, albums etc. via spotify: scheme and steam supports doing a ton of things via URI, including launching and even installing/uninstalling games.

    All you need is an <a> tag with the right href= set. So yeah, you can put that kind of a link in a widget, but if they wanted to have it be an action under a post, especially if it was supposed to include some information from the post, it wouldn't be that simple.
    (side note: NodeBB doesn't allow links using non-standard schemes in markdown, so you can't just put something like this in a post or signature)

  • Child theme from Harmony theme - build problem

    4
    0 Votes
    4 Posts
    190 Views
    barisB

    It is actually something nodebb specific, when building the active theme nodebb core looks for the overrides.scss file. This file needs to be imported in a specific order for it to work.

  • Overriding client-side js

    6
    0 Votes
    6 Posts
    262 Views
    R

    @baris That should work, I'll give it a shot.

    I love the customizability of nodeBB. Particularly the ability to override templates and language files in the custom themes. It would be amazing if that capability could be extended to other file types as well just by placing the customized files in a folder structure that mimics the structure of the core files.

  • How to output logs in plugins?

    Solved
    3
    0 Votes
    3 Posts
    148 Views
    jszsjJ

    @baris Thanks, I figured out that the code wasn't being triggered, just as you said. I'm getting output now!

  • Hook for infinite scroll

    6
    0 Votes
    6 Posts
    223 Views
    R

    @baris Thanks for the confirmation

  • Redirect to login

    Solved
    16
    0 Votes
    16 Posts
    2k Views
    F

    Hello @jalathpc_demo

    I tried to create a patch:
    https://github.com/LM1LC3N7/nodebb-plugin-private-forum/releases/tag/v1.3.1

    I no longer have a NodeBB instance, so let me know if it works (I am honestly not sure, as /logout should be allowed as you are logged in.

    It would be interesting to check if req.loggedIn is correctly set when using SSO. This could be why the plugin is not working as you need.

    NPM link: https://www.npmjs.com/package/nodebb-plugin-private-forum/v/1.3.1