Adding Extending page with hook examples #5707

joshcanhelp · 2018-02-08T17:58:27Z

We've got documentation all over and this is a first step towards consolidating on auth0.com/docs. This new page replaces the examples that are currently on the repo README page (removed on the next release) with tested, documented examples. I also cleaned up the "read more" links at the end of each article.

jeffreylees

Looks good. A few minor content suggestions as marked.

To help us organize these, I have a thought.

It'd be nice to get all of this onto the docs sidebar.
If that can't be done (I doubt it can) I'm going to submit a PR sometime to add them all anyway, CMS/WordPress with all these subpages, then hide them from the sidebar with metadata. This will allow the breadcrumbs we're implementing to work right, which will at least aid people in understanding where they are and how to get back up a level or two.

jeffreylees · 2018-02-13T03:46:08Z

articles/cms/wordpress/extending.md

+
+This filter is called after the plugin finds the related user to login (based on the auth0 `user_id`) and is used to override the default behaviour with custom matching rules (for example, always match by email).
+
+If the filter returns null, it will lookup by email as described in the [How does it work?](https://auth0.com/docs/cms/wordpress/how-does-it-work) document.


Relative docs URL - [How does it work?](/cms/wordpress/how-does-it-work)

jeffreylees · 2018-02-13T03:47:04Z

articles/cms/wordpress/extending.md

+
+Actions in WordPress run custom code at specific points during processing. [Learn more about actions here](https://developer.wordpress.org/plugins/hooks/actions/). 
+
+### `auth0_before_login`


For headings that have function names or variables or whatever else we normally don't do the backticks, sometimes formatting can go kind of wonky. Same with the others below.

@jeffreylees - For these, I thought it would be handy to have an anchor link and have them stand out a bit. Formatting seems to work:

https://auth0-docs-content-pr-5707.herokuapp.com/docs/cms/wordpress/extending

Any other ideas?

I'll have to point this out as well since it is not consistent with the formatting we follow at all docs. We don't use backtips on headers (it doesn't look like a header any longer but some hybrid) so in order to be consistent with the rest of the documentation you have to remove them.

jeffreylees · 2018-02-13T03:48:29Z

articles/cms/wordpress/extending.md

+
+### `auth0_verify_email_page`
+
+This filter runs in `WP_Auth0_Email_Verification` to change the HTML rendered when a logging-in user needs to verify 


...when a user who is logging in needs to...

Jet lag grammer 😆

joshcanhelp · 2018-02-16T18:57:23Z

@cocojoe - LGTY?

cocojoe

Optimise Nexts Steps

cocojoe · 2018-02-19T17:13:35Z

articles/cms/wordpress/jwt-authentication.md

@@ -53,3 +53,15 @@ Vydcvl6gpWNeUE

 - [Cookies vs Tokens. Getting auth right with Angular.JS](https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/)
 - [10 Things You Should Know about Tokens](https://auth0.com/blog/2014/01/27/ten-things-you-should-know-about-tokens-and-cookies/)
+
+## Keep Reading


Rather than repeating this lots of times in 5 files, can it be turned into an include? I don't really mind if the current section is included in the next-steps?

@cocojoe - I'll add it to my list for the next go-around, I have a number of things that need improving.

OK to approve for now?

For future reference, we don't include in one doc links that point to the same doc. We have them reported back as broken links (it has happened more than once). So if you do use a doc fragment at some point make sure that the same doc does not list itself.

cocojoe

Remember to Unify the next steps in the near future.

joshcanhelp · 2018-02-23T17:16:34Z

@mpaktiti - Ready for you! I've got a release waiting (Monday at the earliest). Thank you!

mpaktiti

Left some comments. This also needs an update feed entry since it's a new doc.

mpaktiti · 2018-02-26T11:00:19Z

articles/cms/wordpress/configuration.md

@@ -297,4 +297,5 @@ For more information on the Login by Auth0 WordPress Plugin, follow these links.
 * [Installation](/cms/wordpress/installation)
 * [JWT Authentication](/cms/wordpress/jwt-authentication)
 * [Troubleshoot](/cms/wordpress/troubleshoot)
+* [Extension](/cms/wordpress/extension)


The link throws a 404. This should match the name of the file (so either the links will be /cms/wordpress/extending or the new file will be named extension.md.

mpaktiti · 2018-02-26T11:04:19Z

articles/cms/wordpress/index.md

+* [JWT Authentication](/cms/wordpress/jwt-authentication)
+* [Troubleshoot](/cms/wordpress/troubleshoot)
+* [Extending](/cms/wordpress/extending)
+:::


This element should hold tops 5 items (design rules), so one has to go. Also, consider more descriptive names (for example Install the plugin instead of Installation)

mpaktiti · 2018-02-26T11:04:27Z

articles/cms/wordpress/installation.md

@@ -65,4 +65,5 @@ Now you're ready to [Configure](/cms/wordpress/configuration)!
 * [How does it work?](/cms/wordpress/how-does-it-work)
 * [JWT Authentication](/cms/wordpress/jwt-authentication)
 * [Troubleshoot](/cms/wordpress/troubleshoot)
+* [Extension](/cms/wordpress/extension)


mpaktiti · 2018-02-26T11:07:17Z

articles/cms/wordpress/extending.md

+description: How to extend the Login by Auth0 WordPress Plugin with hooks, filters, and functions.
+---
+
+# Extending Login by Auth0 WordPress Plugin


Looks like a the is missing here, "Extending the Login WordPress Plugin"

mpaktiti · 2018-02-26T11:08:18Z

articles/cms/wordpress/extending.md

@@ -0,0 +1,228 @@
+---
+description: How to extend the Login by Auth0 WordPress Plugin with hooks, filters, and functions.


add metadata toc: true

more info https://github.com/auth0/docs/blob/master/CONTRIBUTING.md#front-matter

mpaktiti · 2018-02-26T11:11:02Z

articles/cms/wordpress/extending.md

+
+Actions in WordPress run custom code at specific points during processing. [Learn more about actions here](https://developer.wordpress.org/plugins/hooks/actions/). 
+
+### `auth0_before_login`


I'll have to point this out as well since it is not consistent with the formatting we follow at all docs. We don't use backtips on headers (it doesn't look like a header any longer but some hybrid) so in order to be consistent with the rest of the documentation you have to remove them.

mpaktiti · 2018-02-26T11:21:08Z

articles/cms/wordpress/extending.md

+
+We're happy to review and approve new filters and actions that help you integrate even further in this plugin. Please
+ see the Contributing section on the [GitHub repo readme for this plugin](https://github.com/auth0/wp-auth0/blob/master/README.md).
+


I had to stop and think for a bit here when I first read this intro. It feels like there is a short paragraph missing at the start explaining what this doc is about (start with sth like "You can create new filters and actions for your Auth0 WordPress Plugin......."). Also this doc lists a set of actions and filters so you should also talk about this in the intro (I had to scroll to see what this doc is about). So if this doc is listing the existing filters and actions say so at the beginning.

mpaktiti · 2018-02-26T11:22:05Z

articles/cms/wordpress/extending.md

+}
+add_filter( 'auth0_login_css', 'a0_docs_ex_auth0_login_css' );
+```
+


You are missing a header before the next-steps element

mpaktiti · 2018-02-26T11:24:20Z

articles/cms/wordpress/jwt-authentication.md

@@ -53,3 +53,15 @@ Vydcvl6gpWNeUE

 - [Cookies vs Tokens. Getting auth right with Angular.JS](https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/)
 - [10 Things You Should Know about Tokens](https://auth0.com/blog/2014/01/27/ten-things-you-should-know-about-tokens-and-cookies/)
+
+## Keep Reading


For future reference, we don't include in one doc links that point to the same doc. We have them reported back as broken links (it has happened more than once). So if you do use a doc fragment at some point make sure that the same doc does not list itself.

joshcanhelp · 2018-02-26T16:42:30Z

@mpaktiti - Thanks for the thorough review! All items have been addressed.

One question ... the main reason for the backtick headers was to be able to link directly to specific hooks here in the doc. I don't see anything in the contrib doc about anchor links. Is it possible to do that?

mpaktiti · 2018-02-26T19:34:27Z

@joshcanhelp You should use H3 and remove the backticks, this way we will have anchors plus they will be listed in the In this Article dropdown at the top right for easy access (this was added due to the toc metadata you set). The rest of the changes look good to go 👍

joshcanhelp · 2018-02-27T15:47:33Z

@mpaktiti - Ready to go!

joshcanhelp added 4 commits February 1, 2018 13:59

starting extend docs

0dfc244

progress on hooks documentation

c7396f6

progress adding hooks

00cf6be

adding action and filter examples

705ca73

joshcanhelp requested review from cocojoe and jeffreylees February 8, 2018 17:58

solepano temporarily deployed to auth0-docs-content-pr-5707 February 8, 2018 17:58 Inactive

joshcanhelp added the ready-for-review label Feb 8, 2018

joshcanhelp mentioned this pull request Feb 8, 2018

Readme updates auth0/wordpress#392

Merged

jeffreylees reviewed Feb 13, 2018

View reviewed changes

relative docs link, better wording

aec49db

solepano temporarily deployed to auth0-docs-content-pr-5707 February 13, 2018 14:04 Inactive

jeffreylees approved these changes Feb 16, 2018

View reviewed changes

cocojoe reviewed Feb 19, 2018

View reviewed changes

cocojoe approved these changes Feb 23, 2018

View reviewed changes

joshcanhelp mentioned this pull request Feb 23, 2018

Release 3.5.2 auth0/wordpress#399

Merged

mpaktiti suggested changes Feb 26, 2018

View reviewed changes

mpaktiti added update-needed and removed ready-for-review labels Feb 26, 2018

review fixes

de19718

solepano temporarily deployed to auth0-docs-content-pr-5707 February 26, 2018 16:39 Inactive

joshcanhelp added ready-for-review and removed update-needed labels Feb 26, 2018

update file

dc28046

solepano temporarily deployed to auth0-docs-content-pr-5707 February 26, 2018 16:50 Inactive

H3 headers

fb3a734

solepano deployed to auth0-docs-content-pr-5707 February 27, 2018 15:47 View deployment

mpaktiti merged commit 83ecc39 into master Feb 27, 2018

mpaktiti deleted the joshc-adding-wp-extend branch February 27, 2018 17:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Extending page with hook examples #5707

Adding Extending page with hook examples #5707

joshcanhelp commented Feb 8, 2018

jeffreylees left a comment

jeffreylees Feb 13, 2018

jeffreylees Feb 13, 2018

joshcanhelp Feb 13, 2018

mpaktiti Feb 26, 2018

jeffreylees Feb 13, 2018

joshcanhelp Feb 13, 2018

joshcanhelp commented Feb 16, 2018

cocojoe left a comment

cocojoe Feb 19, 2018

joshcanhelp Feb 19, 2018

cocojoe Feb 23, 2018

mpaktiti Feb 26, 2018

cocojoe left a comment

joshcanhelp commented Feb 23, 2018

mpaktiti left a comment

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

mpaktiti Feb 26, 2018

joshcanhelp commented Feb 26, 2018

mpaktiti commented Feb 26, 2018

joshcanhelp commented Feb 27, 2018


		This filter is called after the plugin finds the related user to login (based on the auth0 `user_id`) and is used to override the default behaviour with custom matching rules (for example, always match by email).

		If the filter returns null, it will lookup by email as described in the [How does it work?](https://auth0.com/docs/cms/wordpress/how-does-it-work) document.


		Actions in WordPress run custom code at specific points during processing. [Learn more about actions here](https://developer.wordpress.org/plugins/hooks/actions/).

		### `auth0_before_login`


		### `auth0_verify_email_page`

		This filter runs in `WP_Auth0_Email_Verification` to change the HTML rendered when a logging-in user needs to verify

		@@ -0,0 +1,228 @@
		---
		description: How to extend the Login by Auth0 WordPress Plugin with hooks, filters, and functions.


		We're happy to review and approve new filters and actions that help you integrate even further in this plugin. Please
		see the Contributing section on the [GitHub repo readme for this plugin](https://github.com/auth0/wp-auth0/blob/master/README.md).

Adding Extending page with hook examples #5707

Adding Extending page with hook examples #5707

Conversation

joshcanhelp commented Feb 8, 2018

jeffreylees left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshcanhelp commented Feb 16, 2018

cocojoe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cocojoe left a comment

Choose a reason for hiding this comment

joshcanhelp commented Feb 23, 2018

mpaktiti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshcanhelp commented Feb 26, 2018

mpaktiti commented Feb 26, 2018

joshcanhelp commented Feb 27, 2018