WordPress.org

Make WordPress Core

Opened 16 months ago

Closed 16 months ago

Last modified 16 months ago

#47423 closed defect (bug) (fixed)

Docs: Added the `locale` field to description for insert_user_meta filter.

Reported by: tmatsuur Owned by: desrosj
Milestone: 5.3 Priority: normal
Severity: normal Version: 4.7
Component: Users Keywords: has-patch commit
Focuses: docs Cc:

Description

Since there was an anxious part in the source code of wp_insert_user function, I will post it.

In version 4.7, the insert_user_meta filter corresponds to the locale field, but this document does not describe it.

I think that it is better to correct the document.

Attachments (1)

47423.diff (922 bytes) - added by tmatsuur 16 months ago.

Download all attachments as: .zip

Change History (5)

@tmatsuur
16 months ago

#1 @desrosj
16 months ago

  • Focuses docs added
  • Milestone changed from Awaiting Review to 5.3
  • Owner set to desrosj
  • Status changed from new to reviewing

#2 follow-up: @desrosj
16 months ago

  • Keywords commit added
  • Version set to 4.7

Thanks for catching this, @tmatsuur!

Looks like the locale user meta field was introduced in [38705] for version 4.7 and the filter documentation was just missed.

Version 0, edited 16 months ago by desrosj (next)

#3 @desrosj
16 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 45479:

Docs: Add missing documentation for the locale meta field.

The user’s locale is passed in the $meta parameter for insert_user_meta. Added in [38705].

Props tmatsuur.
Fixes #47423.

#4 in reply to: ↑ 2 @tmatsuur
16 months ago

Replying to desrosj:

I don't think we need to add a @since annotation because no parameters were added to the filter, just possible values within the $meta array. I can change that when I commit.

Thanks @desrosj

In such cases, I did not know that @ since is unnecessary. I want to be careful in the future.

Note: See TracTickets for help on using tickets.