Browse Source

Add docs for user_registered hook

Peter Justin 7 years ago
parent
commit
5857a8ef1b
4 changed files with 8 additions and 4 deletions
  1. 1 0
      docs/hooks.rst
  2. 1 1
      flaskbb/auth/plugins.py
  3. 1 1
      flaskbb/auth/views.py
  4. 5 2
      flaskbb/plugins/spec.py

+ 1 - 0
docs/hooks.rst

@@ -62,6 +62,7 @@ FlaskBB Event Hooks
 .. autofunction:: flaskbb_event_post_save_after
 .. autofunction:: flaskbb_event_topic_save_before
 .. autofunction:: flaskbb_event_topic_save_after
+.. autofunction:: flaskbb_event_user_registered
 
 
 FlaskBB Form Hooks

+ 1 - 1
flaskbb/auth/plugins.py

@@ -9,7 +9,7 @@ from ..utils.settings import flaskbb_config
 
 
 @impl
-def flaskbb_user_registered(username):
+def flaskbb_event_user_registered(username):
     user = User.query.filter_by(username=username).first()
 
     if flaskbb_config["ACTIVATE_ACCOUNT"]:

+ 1 - 1
flaskbb/auth/views.py

@@ -156,7 +156,7 @@ class Register(MethodView):
 
                     return render_template("auth/register.html", form=form)
 
-            current_app.pluggy.hook.flaskbb_user_registered(
+            current_app.pluggy.hook.flaskbb_event_user_registered(
                 username=registration_info.username
             )
             return redirect_or_next(url_for('forum.index'))

+ 5 - 2
flaskbb/plugins/spec.py

@@ -143,8 +143,11 @@ def flaskbb_event_topic_save_after(topic, is_new):
 
 
 @spec
-def flaskbb_user_registered(username):
-    """Hook for handling events after a user is registered"""
+def flaskbb_event_user_registered(username):
+    """Hook for handling events after a user is registered
+
+    :param username: The username of the newly registered user.
+    """
 
 
 # Form hooks