Hook Docs: wp-signup.php

[miyauchi]

Attached patch has done for the all hooks in wp-signup.php

[miyauchi]

inline docs for wp-signup.php

[miyauchi]

fixed typo. :)

[DrewAPicture]

Hi miyauchi,

wp-signup.2.diff​ is a good start.

General notes:

• Change "Fires actions" to "Fires"
• @since versions should use the 3-digit x.x.x style, e.g. 3.0.0
• Short descriptions should all start with a capital letter
• All @param lines need a short description ending with a period
• Try to avoid "Allows" in filter descriptions. Focus on what is filterable. e.g. "Filter X"
• Space out all documented action or filter lines (only) per coding standards. e.g.

do_action('signup_blogform', $errors);
becomes
do_action( 'signup_blogform', $errors );

• Generally: clarity over succinctness is preferred. Short descriptions should be a complete sentence

Specific hooks:

• Remove // allow definition of default variables since it's being replaced
• For the signup_another_blog_init filter, the @param is incorrect. I'd suggest breaking the array out to a variable first, then using the variable in the filter. For instance:

  <?php
  $signup_defaults = array(
          'blogname'   => $blogname,
          'blog_title' => $blog_title,
          'errors'     => $errors
  );
  /**
   * Filter default site signup variables.
   *
   * @since 3.0.0
   * @param array $signup_defaults An array of default site signup variables.
   */
  $filtered_results = apply_filters( 'signup_another_blog_init', $signup_defaults );
  

• Some short descriptions need to be more clear. Such as "Add extra hidden fields to the form of sign up another blog." could be clearer as "Add extra hidden fields to the site signup form.
• The signup_create_blog_meta filter needs the same treatment as the signup_another_blog_init filter example above
• "Filter for the new" should be "Filter the new"

I'm gonna stop here. Let's work through the stuff I talked about above to the point you can generate a new patch then we'll see where we're at :)

[miyauchi]

some fix

[miyauchi]

Hi Drew,

Thanks for review. :)
I was fixed !

[miyauchi]

Bug fix.

[DrewAPicture]

FYI, the signup_hidden_fields hook has already been documented in [25600]

[miyauchi]

Replying to DrewAPicture:

FYI, the signup_hidden_fields hook has already been documented in [25600]

I see. I'll mark it as duplicate hook.

[DrewAPicture]

Replying to miyauchi:

Replying to DrewAPicture:

FYI, the signup_hidden_fields hook has already been documented in [25600]

I see. I'll mark it as duplicate hook.

Actually, the point I was making (not very clearly) was that you'll need to update the file before you re-patch it because these changes were made to the file you're working on.

[miyauchi]

patch for r25600

[miyauchi]

I make a patch from r25600. :)

[kpdesign]

Second pass on wp-signup.5.diff

[DrewAPicture]

@kpdesign: Thanks for the updated patch!

We're almost over the finish line. What's left:

• signup_blogform, signup_extra_fields the $errors param is missing docs
• I guess we should do @since MU for signup_create_blog_meta if it was deprecated in 3.0.0
• s/$signup_user_default/$signup_user_defaults
• s/$signup_blog_default/$signup_blog_defaults
• Several array hash notations are missing

[DrewAPicture]

see comment:13

[DrewAPicture]

@kpdesign, would you like to do a final review on wp-signup.7.diff​? I covered everything in comment:13.

[miyauchi]

@deprecated 3.0.0

     * @param array $blog_meta_defaults {
     *     An array of default blog meta variables.
     *
     *     @type int 'lang_id'     The language ID.
     *     @type int 'blog_public' Whether the blog is indexable by search engines. 1 for true, 0 for false.
     * }

Oh! I see! Thanks!

[DrewAPicture]

Final pass s/sign up/sign-up, array keys to $variables in hash notations

[DrewAPicture]

Typo + moar s/signup/sign-up

[kpdesign]

Reviewed wp-signup.9.diff​. Looks good, recommend commit.

[DrewAPicture]

In 25645:

Inline documentation for hooks in wp-signup.php.

Props kpdesign, miyauchi.

Fixes #25381.

[DrewAPicture]

Hook docs fixes