├── .nvmrc ├── LICENSE ├── README.md ├── assets └── images │ ├── altis-logo.png │ ├── hm-logo.png │ └── siemens-logo.png ├── authorship.code-workspace ├── composer.json ├── inc ├── admin.php ├── class-insert-post-handler.php ├── class-users-controller.php ├── cli │ ├── class-migrate-command.php │ └── namespace.php ├── namespace.php ├── taxonomy.php └── template.php ├── plugin.php └── src ├── components ├── AuthorsSelect.tsx ├── SortableMultiValueElement.tsx └── SortableSelectContainer.tsx ├── index.tsx ├── plugin.tsx ├── style.scss ├── types.ts └── utils └── arrayMove.ts /.nvmrc: -------------------------------------------------------------------------------- 1 | v16 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Authorship 2 | 3 | Stable tag: 0.2.17 4 | Requires at least: 5.4 5 | Tested up to: 6.2 6 | Requires PHP: 7.2 7 | License: GPL v3 or later 8 | Contributors: johnbillion, humanmade 9 | 10 | A modern approach to author attribution in WordPress. 11 | 12 | ## Description 13 | 14 | Authorship is a modern approach to author attribution in WordPress. It supports attributing posts to multiple authors and to guest authors, provides a great UI, and treats API access to author data as a first-class citizen. 15 | 16 | Authorship is currently geared toward developers who are implementing custom solutions on WordPress. For example, it doesn't provide an option to automatically display author profiles at the bottom of a post. In the future it will include wider support for existing themes and useful features for implementors and site builders. 17 | 18 | --- 19 | 20 | - [Current Status](#current-status) 21 | - [Features](#features) 22 | - [Installation](#installation) 23 | - [Design Decisions](#design-decisions) 24 | - [Template Functions](#template-functions) 25 | - [REST API](#rest-api) 26 | - [WP-CLI](#wp-cli) 27 | - [Email Notifications](#email-notifications) 28 | - [Accessibility](#accessibility) 29 | - [Security, Privileges, and Privacy](#security-privileges-and-privacy) 30 | - [Contributing](#contributing) 31 | - [Team](#team) 32 | - [License](#license) 33 | - [Alternatives](#alternatives) 34 | 35 | --- 36 | 37 | ## Current Status 38 | 39 | **Alpha**. Generally very functional but several features are still in development. 40 | 41 | ## Features 42 | 43 | * [X] Multiple authors per post 44 | * [X] Guest authors (that can be created in place on the post editing screen) 45 | * [X] A convenient and user-friendly UI that feels like a part of WordPress 46 | * [X] Works with the block editor 47 | * [ ] Works with the classic editor 48 | * [X] Full CRUD support in the REST API and WP-CLI 49 | * [X] Full support in RSS feeds 50 | * [ ] Full support in Atom feeds 51 | * [X] Fine-grained user permission controls 52 | 53 | _Features without a checkmark are still work in progress._ 54 | 55 | ## Installation 56 | 57 | ### For normal use 58 | 59 | composer require humanmade/authorship 60 | 61 | ### For development use 62 | 63 | * Clone this repo into your plugins directory 64 | * Ensure you have Composer v2 and Node v16 installed 65 | * Install the dependencies: 66 | `composer install && npm install` 67 | * Start the dev server: 68 | `npm run start` 69 | 70 | ## Design Decisions 71 | 72 | Why another multi-author plugin? What about Co-Authors Plus or Bylines or PublishPress Authors? 73 | 74 | Firstly, those plugins are great and have served us well over the years, however they all suffer from similar problems: 75 | 76 | * API: Lack of support for writing and reading author data via the REST API and WP-CLI 77 | * UI: Limited or custom UI that doesn't feel like a part of WordPress 78 | * Users: An unnecessary distinction between guest authors and actual WordPress users 79 | 80 | Let's look at these points in detail and explain how Authorship addresses them: 81 | 82 | ### API design decisions 83 | 84 | There's a lot more to a modern WordPress site than just its theme. Data gets written to and read from its APIs, so these need to be treated as first-class citizens when working with the attributed authors of posts. 85 | 86 | Authorship provides: 87 | 88 | * Ability to read and write attributed authors via an `authorship` field on the `wp/v2/posts` REST API endpoints 89 | * Ability to create guest authors via the `authorship/v1/users` REST API endpoint 90 | * Read-only access to users who can be attributed to a post via the `authorship/v1/users` REST API endpoint 91 | * Ability to specify attributed authors when creating or updating posts via WP-CLI with the `--authorship` flag 92 | 93 | ### UI design decisions 94 | 95 | We'd love it if you activated Authorship and then forgot that its features are provided by a plugin. The UI provides convenient functionality without looking out of place, both in the block editor and the classic editor. 96 | 97 | ### User design decisions 98 | 99 | Existing plugins that provide guest author functionality make a distinction between a guest author and a real WordPress user. A guest author exists only as a taxonomy term, which complicates the UX and creates inconsistencies and duplication in the data. 100 | 101 | Authorship creates a real WordPress user account for each guest author, which provides several advantages: 102 | 103 | * No custom administration screens for managing guest authors separately from regular users 104 | * Plugins that customise user profiles work for guest authors too 105 | * Consistent data structure - you only ever deal with `WP_User` objects 106 | * No need to keep data in sync between a user and their "author" profile 107 | * Promoting a guest author to a functional user is done just by changing their user role 108 | 109 | ## Template Functions 110 | 111 | The following template functions are available for use in your theme to fetch the attributed author(s) of a post: 112 | 113 | * `\Authorship\get_author_names( $post )` 114 | - Returns a comma-separated list of the names of the attributed author(s) 115 | * `\Authorship\get_author_names_sentence( $post )` 116 | - Returns a sentence stating the names of the attributed author(s), localised to the current language 117 | * `\Authorship\get_author_names_list( $post )` 118 | - Returns an unordered HTML list of the names of the attributed author(s) 119 | * `\Authorship\get_authors( $post )` 120 | - Returns a list of user objects of the attributed authors 121 | * `\Authorship\get_author_ids( $post )` 122 | - Returns a list of user ids of the attributed authors 123 | 124 | ## REST API 125 | 126 | The following REST API endpoints and fields are available: 127 | 128 | ### `authorship/v1/users` endpoint 129 | 130 | This endpoint allows: 131 | 132 | * Searching all users who can be attributed to content 133 | * Creating guest authors 134 | 135 | ### `authorship` field 136 | 137 | This field is added to the endpoint for all supported post types (by default, ones which that have post type support for `author`), for example `wp/v2/posts`. This field is readable and writable and accepts and provides an array of IDs of users attributed to the post. 138 | 139 | In addition, user objects are embedded in the `_embedded['wp:authorship']` field in the response if `_embed` is set and the authenticated user can list users. 140 | 141 | ## WP-CLI 142 | 143 | Authorship implements a custom flag for use with posts, and migration commands. 144 | The following WP-CLI flags are available: 145 | 146 | - `--authorship` 147 | 148 | ### `--authorship` flag 149 | 150 | When creating or updating posts the `--authorship` flag can be used to specify the IDs of users attributed to the post. The flag accepts a comma-separated list of user IDs. Examples: 151 | 152 | * `wp post create --post_title="My New Post" --authorship=4,11` 153 | * `wp post update 220 --authorship=13` 154 | 155 | If this flag is *not* set: 156 | 157 | * When creating a new post, if the `--post_author` flag is set then it will be used for attributed authors 158 | * When updating an existing post, no change will be made to attributed authors 159 | 160 | ### Migration of WordPress authors on existing posts. 161 | 162 | If you activate Authorship on an existing site, all content already created will not have authorship data set for old content. This breaks things such as author archive pages. 163 | 164 | This command will set the WordPress author as the authorship user for any posts with no authorship user. (Optionally you can override any existing authorship data, updating it with the WordPress post author). 165 | 166 | ```sh 167 | wp authorship migrate wp-authors --dry-run=true 168 | ``` 169 | 170 | The command will perform a dry run by default, setting `--dry-run=false` will make changes to the database. 171 | 172 | This command will not overwrite or update Authorship data unless the `--overwrite-authors=true` flag is set. 173 | 174 | ### PublishPress Authors Migration 175 | 176 | Authorship provides a command for creating Authorship data using data from PublishPress Authors. This allows a non-destructive migration path from PublishPress Authors. 177 | 178 | With both plugins active, this command will copy PPA data into Authorship: 179 | 180 | ```sh 181 | wp authorship migrate ppa --dry-run=true 182 | ``` 183 | 184 | The command will perform a dry run by default, setting `--dry-run=false` will make changes to the database. Guest authors that do not exist as users will be created with blank emails and random passwords. 185 | 186 | This command will not overwrite or update Authorship data unless the `--overwrite-authors=true` flag is set. 187 | 188 | ## Email Notifications 189 | 190 | Authorship does not send any email notifications itself, but it does instruct WordPress core to additionally send its emails to attributed authors when appropriate. 191 | 192 | * When a comment on a post is held for moderation, the comment moderation email also gets sent to all attributed authors who have the ability to moderate the comment and have a valid email address 193 | * When a comment on a post is published, the comment notification email also gets sent to all attributed authors who have a valid email address 194 | 195 | This plugin only adjusts the list of email addresses to which these emails get sent. If you want to disable these emails entirely, see the "Email me whenever" section of the Settings -> Discussion screen in WordPress. 196 | 197 | ## Accessibility 198 | 199 | Authorship aims to conform to Web Content Accessibility Guidelines (WCAG) 2.1 at level AA but it does not yet fully achieve this. If full support for assistive technology is a requirement of your organisation then Authorship may not be a good fit in its current state. 200 | 201 | With regard to the author selection control on the post editing screen: 202 | 203 | * ✅ The visual styles are inherited from WordPress core and are WCAG 2.1 AA compliant 204 | * ✅ The control is fully accessible using only the keyboard 205 | * 🚫 The keyboard controls are not very intuitive 206 | * 🚫 The control is not fully accessible when using a screen reader 207 | 208 | The team are actively investigating either replacing the component used to render the control with a fully accessible one, or fixing the accessibility issues of the current one. 209 | 210 | ## Security, Privileges, and Privacy 211 | 212 | Great care has been taken to ensure Authorship makes no changes to the user capabilities required to edit content or view sensitive user data on your site. What it *does* do is: 213 | 214 | * Grant users who are attributed to a post the ability to edit that post if their capabilities allow it 215 | * Grant users the ability to create and assign guest authors to a post 216 | * Allow this behaviour to be changed at a granular level with custom capabilities 217 | 218 | ### Assigning Attribution 219 | 220 | The capability required to change the attribution of a post matches that which is required by WordPress core to change the post author. This means a user needs the `edit_others_post` capability for the post type. The result is no change in behaviour from WordPress core with regard to being able to attribute a post to another user. 221 | 222 | * Administrators and Editors can change the attributed authors of a post 223 | * Authors and Contributors cannot change the attributed authors and see a read-only list when editing a post 224 | 225 | Authorship allows the attribution to be changed for any post type that has post type support for `author`, which by default is Posts and Pages. 226 | 227 | ### Editing Posts 228 | 229 | When a user is attributed to a post, that user becomes able to manage that post according to their capabilities as if they were the post author. This means: 230 | 231 | * A post that is attributed to a user with a role of Author can be edited, published, and deleted by that user 232 | * A post that is attributed to a user with a role of Contributor can be edited by that user while in draft, but cannot be not published, and cannot be edited once published 233 | 234 | From a practical point of view this feature only affects users with a role of Author or Contributor. Administrators and Editors can edit other users' posts by default and therefore edit, publish, and delete posts regardless of whether they are attributed to it. 235 | 236 | ### Searching Users 237 | 238 | The `authorship/v1/users` REST API endpoint provides a means of searching users on the site in order to attribute them to a post. Access to this endpoint is granted to all users who have the capability to change the attributed authors of the given post type, which means Editors and Administrators by default. The result is no change in behaviour from WordPress core with regard to being able to search users. 239 | 240 | In addition, this endpoint has been designed to expose minimal information about users, for example it does not expose email addresses or capabilities. This allows lower level users such as users with a role of Author to be granted the ability to attribute users to a post without unnecessarily exposing sensitive information about other users. 241 | 242 | ### Creating Guest Authors 243 | 244 | The `authorship/v1/users` REST API endpoint provides a means of creating guest authors that can subsequently be attributed to a post. Access to this endpoint is granted to all users who have the ability to edit others' posts, which means Editors and Administrators by default. 245 | 246 | More work is still to be done around the ability to subsequently edit guest authors, but it's worth noting that this is the one area where Authorship diverges from the default capabilities of WordPress core. It allows an Editor role user to create a new user account, which they usually cannot do. However it is tightly controlled: 247 | 248 | * An email address cannot be provided unless the user has the `create_users` capability, which only Administrators do 249 | * A user role cannot be provided, it is always set to Guest Author 250 | 251 | ### Capability Customisation 252 | 253 | The following custom user capabilities are used by Authorship. These can be granted to or denied from users or roles in order to adjust user access: 254 | 255 | * `attribute_post_type` 256 | - Used when attributing users to a given post type 257 | - Maps to the `edit_others_posts` capability of the post type by default 258 | * `create_guest_authors` 259 | - Used when creating a guest author 260 | - Maps to `edit_others_posts` by default 261 | 262 | ## Contributing 263 | 264 | Code contributions, feedback, and feature suggestions are very welcome. See [CONTRIBUTING.md](https://github.com/humanmade/authorship/blob/master/CONTRIBUTING.md) for more details. 265 | 266 | ## Team 267 | 268 | Authorship is developed and maintained by [Human Made](https://humanmade.com) and [Altis](https://www.altis-dxp.com). Its initial development was funded by [Siemens](https://www.siemens.com). 269 | 270 |

271 | Human Made 272 | Altis DXP 273 | Siemens 274 |

275 | 276 | ## License 277 | 278 | This program is free software; you can redistribute it and/or modify 279 | it under the terms of the GNU General Public License as published by 280 | the Free Software Foundation; either version 3 of the License, or 281 | (at your option) any later version. 282 | 283 | This program is distributed in the hope that it will be useful, 284 | but WITHOUT ANY WARRANTY; without even the implied warranty of 285 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 286 | GNU General Public License for more details. 287 | 288 | ## Alternatives 289 | 290 | If the Authorship plugin doesn't suit your needs, try these alternatives: 291 | 292 | * [PublishPress Authors](https://wordpress.org/plugins/publishpress-authors/) 293 | * [Co-Authors Plus](https://wordpress.org/plugins/co-authors-plus/) 294 | * [Guest Author](https://wordpress.org/plugins/guest-author/) 295 | -------------------------------------------------------------------------------- /assets/images/altis-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/humanmade/authorship/b73358cbc75a6a75ef647ad41a0e649a76c8edc0/assets/images/altis-logo.png -------------------------------------------------------------------------------- /assets/images/hm-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/humanmade/authorship/b73358cbc75a6a75ef647ad41a0e649a76c8edc0/assets/images/hm-logo.png -------------------------------------------------------------------------------- /assets/images/siemens-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/humanmade/authorship/b73358cbc75a6a75ef647ad41a0e649a76c8edc0/assets/images/siemens-logo.png -------------------------------------------------------------------------------- /authorship.code-workspace: -------------------------------------------------------------------------------- 1 | { 2 | "extensions": { 3 | "recommendations": [ 4 | "bmewburn.vscode-intelephense-client", 5 | "breezelin.phpstan", 6 | "dbaeumer.vscode-eslint", 7 | "editorconfig.editorconfig", 8 | "felixfbecker.php-debug", 9 | "johnbillion.vscode-wordpress-hooks", 10 | "neilbrayfield.php-docblocker", 11 | "shevaua.phpcs", 12 | "stylelint.vscode-stylelint" 13 | ], 14 | "unwantedRecommendations": [ 15 | "ikappas.phpcs" 16 | ] 17 | }, 18 | "settings": { 19 | "files.associations": { 20 | ".env.dist": "dotenv", 21 | "*.neon.dist": "neon", 22 | "*.xml.dist": "xml" 23 | }, 24 | "files.exclude": { 25 | "noop.php": true, 26 | "vendor/roots/wordpress": true 27 | }, 28 | "files.watcherExclude": { 29 | "**/vendor/**": true, 30 | "noop.php": true 31 | }, 32 | "search.exclude": { 33 | "noop.php": true, 34 | "vendor/roots/wordpress": true 35 | }, 36 | "phpstan.configuration": "phpstan.neon.dist", 37 | "phpstan.level": "config" 38 | }, 39 | "folders": [ 40 | { 41 | "path": "." 42 | } 43 | ], 44 | } 45 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "humanmade/authorship", 3 | "description": "Authorship", 4 | "license": "GPL-3.0-or-later", 5 | "type": "wordpress-plugin", 6 | "require": { 7 | "php": ">=7.2", 8 | "composer/installers": "^1.0 || ^2.0", 9 | "humanmade/asset-loader": "^0.5.0 || ^0.6.1" 10 | }, 11 | "require-dev": { 12 | "dealerdirect/phpcodesniffer-composer-installer": "0.7.0", 13 | "ergebnis/composer-normalize": "^2", 14 | "humanmade/coding-standards": "1.1.1", 15 | "php-stubs/wordpress-stubs": "^5.5", 16 | "phpcompatibility/phpcompatibility-wp": "2.1.0", 17 | "phpstan/phpstan": "0.12.57", 18 | "phpunit/phpunit": "^9.5.20", 19 | "roots/wordpress": "~6.6.0", 20 | "squizlabs/php_codesniffer": "3.5.8", 21 | "szepeviktor/phpstan-wordpress": "0.7.1", 22 | "vlucas/phpdotenv": "^3", 23 | "wp-cli/db-command": "^2", 24 | "wp-phpunit/wp-phpunit": "~6.6.0", 25 | "yoast/phpunit-polyfills": "^1.0" 26 | }, 27 | "config": { 28 | "allow-plugins": { 29 | "composer/installers": true, 30 | "dealerdirect/phpcodesniffer-composer-installer": true, 31 | "ergebnis/composer-normalize": true, 32 | "roots/wordpress-core-installer": true 33 | }, 34 | "platform": { 35 | "php": "7.4" 36 | }, 37 | "preferred-install": "dist", 38 | "sort-packages": true 39 | }, 40 | "extra": { 41 | "installer-paths": { 42 | "lib/{$name}/": [ 43 | "humanmade/asset-loader" 44 | ] 45 | }, 46 | "wordpress-install-dir": "tests/wordpress" 47 | }, 48 | "scripts": { 49 | "post-update-cmd": [ 50 | "@composer normalize", 51 | "@php -r \"! file_exists( 'tests/.env' ) && copy( 'tests/.env.dist', 'tests/.env' );\"" 52 | ], 53 | "test": [ 54 | "@test:phpcs", 55 | "@test:phpstan", 56 | "@test:ut" 57 | ], 58 | "test:phpcs": [ 59 | "phpcs -p --cache=tests/cache/phpcs ." 60 | ], 61 | "test:phpstan": [ 62 | "phpstan analyze" 63 | ], 64 | "test:ut": [ 65 | "wp db reset --yes --path=tests/wordpress #", 66 | "export WP_MULTISITE=0 && phpunit --verbose --colors=always --exclude-group=ms-required", 67 | "export WP_MULTISITE=1 && phpunit --verbose --colors=always --exclude-group=ms-excluded" 68 | ] 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /inc/admin.php: -------------------------------------------------------------------------------- 1 | role !== GUEST_ROLE ) { 43 | return; 44 | } 45 | 46 | $error_codes = $errors->get_error_codes(); 47 | $error_codes_to_remove = [ 'empty_email', 'nickname' ]; 48 | $current_codes = array_intersect( $error_codes, $error_codes_to_remove ); 49 | 50 | foreach ( $current_codes as $code ) { 51 | $errors->remove( $code ); 52 | } 53 | } 54 | 55 | /** 56 | * Fires as an admin screen or script is being initialized. 57 | */ 58 | function init_admin_cols() : void { 59 | foreach ( get_supported_post_types() as $post_type ) { 60 | add_filter( "manage_{$post_type}_posts_columns", __NAMESPACE__ . '\\filter_post_columns' ); 61 | add_action( "manage_{$post_type}_posts_custom_column", __NAMESPACE__ . '\\action_author_column', 10, 2 ); 62 | } 63 | } 64 | 65 | /** 66 | * Fires for each custom column of a specific post type in the Posts list table. 67 | * 68 | * @param string $column_name The name of the column to display. 69 | * @param int $post_id The current post ID. 70 | */ 71 | function action_author_column( string $column_name, int $post_id ) : void { 72 | if ( COLUMN_NAME !== $column_name ) { 73 | return; 74 | } 75 | 76 | /** @var WP_Post */ 77 | $post = get_post( $post_id ); 78 | 79 | $authors = get_authors( $post ); 80 | 81 | if ( empty( $authors ) ) { 82 | return; 83 | } 84 | 85 | echo '
    '; 86 | 87 | foreach ( $authors as $user ) { 88 | $url = add_query_arg( [ 89 | 'post_type' => $post->post_type, 90 | 'author' => $user->ID, 91 | ], admin_url( 'edit.php' ) ); 92 | printf( 93 | '
  • %2$s
    • ', 94 | esc_url( $url ), 95 | esc_html( $user->display_name ) 96 | ); 97 | } 98 | 99 | echo '
'; 100 | } 101 | 102 | /** 103 | * Filters the columns displayed in the Posts list table for a specific post type. 104 | * 105 | * @param string[] $post_columns An associative array of column headings. 106 | * @return string[] An associative array of column headings. 107 | */ 108 | function filter_post_columns( array $post_columns ) : array { 109 | $new_columns = []; 110 | 111 | foreach ( $post_columns as $key => $value ) { 112 | if ( 'author' === $key ) { 113 | // This replaces the default Author column with our own, in the same position. 114 | $new_columns[ COLUMN_NAME ] = __( 'Authors', 'authorship' ); 115 | } else { 116 | $new_columns[ $key ] = $value; 117 | } 118 | } 119 | 120 | return $new_columns; 121 | } 122 | -------------------------------------------------------------------------------- /inc/class-insert-post-handler.php: -------------------------------------------------------------------------------- 1 | 23 | */ 24 | private $postarr = []; 25 | 26 | /** 27 | * Filters slashed post data just before it is inserted into the database. 28 | * 29 | * @param mixed[] $data An array of slashed, sanitized, and processed post data. 30 | * @param mixed[] $postarr An array of sanitized (and slashed) but otherwise unmodified post data. 31 | * @param mixed $unsanitized_postarr An array (or object that implements array access, like a WP_Post) of 32 | * slashed yet _unsanitized_ and unprocessed post data as originally passed 33 | * to wp_insert_post(). 34 | * @return mixed[] An array of slashed, sanitized, and processed post data. 35 | */ 36 | function filter_wp_insert_post_data( array $data, array $postarr, $unsanitized_postarr ) : array { 37 | // Make sure the unsanitized post array is actually an array. Core sometimes passes it as a WP_Post object. 38 | $this->postarr = (array) $unsanitized_postarr; 39 | 40 | return $data; 41 | } 42 | 43 | /** 44 | * Fires once a post has been saved. 45 | * 46 | * @param int $post_ID Post ID. 47 | * @param WP_Post $post Post object. 48 | * @param bool $update Whether this is an existing post being updated. 49 | */ 50 | function action_wp_insert_post( int $post_ID, WP_Post $post, bool $update ) : void { 51 | $unsanitized_postarr = $this->postarr; 52 | 53 | $this->postarr = []; 54 | 55 | if ( isset( $unsanitized_postarr['tax_input'] ) && ! empty( $unsanitized_postarr['tax_input'][ TAXONOMY ] ) ) { 56 | return; 57 | } 58 | 59 | $existing_authors = get_authors( $post ); 60 | 61 | if ( $update && ! isset( $unsanitized_postarr[ POSTS_PARAM ] ) && $existing_authors ) { 62 | return; 63 | } 64 | 65 | if ( isset( $unsanitized_postarr[ POSTS_PARAM ] ) ) { 66 | $authors = $unsanitized_postarr[ POSTS_PARAM ]; 67 | } else { 68 | /** 69 | * Set the default authorship author. Defaults to the original post author. 70 | * 71 | * @param array $authors Authors to add to a post on insert if none have been passed. Default to post author. 72 | * @param WP_Post $post Post object. 73 | */ 74 | $authors = array_filter( apply_filters( 75 | 'authorship_default_author', 76 | [ isset( $unsanitized_postarr['post_author'] ) ? $unsanitized_postarr['post_author'] : null ], 77 | $post 78 | ) ); 79 | } 80 | 81 | if ( empty( $authors ) ) { 82 | return; 83 | } 84 | 85 | try { 86 | set_authors( $post, wp_parse_id_list( $authors ) ); 87 | } catch ( Exception $e ) { 88 | // Nothing at the moment. 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /inc/class-users-controller.php: -------------------------------------------------------------------------------- 1 | namespace = self::_NAMESPACE; 40 | $this->rest_base = self::BASE; 41 | } 42 | 43 | /** 44 | * Registers the routes for the objects of the controller. 45 | * 46 | * @return void 47 | */ 48 | public function register_routes() { 49 | register_rest_route( 50 | $this->namespace, 51 | '/' . $this->rest_base, 52 | [ 53 | [ 54 | 'methods' => WP_REST_Server::READABLE, 55 | 'callback' => [ $this, 'get_items' ], 56 | 'permission_callback' => [ $this, 'get_items_permissions_check' ], 57 | 'args' => $this->get_collection_params(), 58 | ], 59 | [ 60 | 'methods' => WP_REST_Server::CREATABLE, 61 | 'callback' => [ $this, 'create_item' ], 62 | 'permission_callback' => [ $this, 'create_item_permissions_check' ], 63 | 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), 64 | ], 65 | 'schema' => [ $this, 'get_public_item_schema' ], 66 | ] 67 | ); 68 | } 69 | 70 | /** 71 | * Permissions check for getting all users. 72 | * 73 | * @param WP_REST_Request $request Full details about the request. 74 | * @return true|WP_Error True if the request has read access, otherwise WP_Error object. 75 | */ 76 | public function get_items_permissions_check( $request ) { 77 | if ( ! current_user_can( 'attribute_post_type', $request->get_param( 'post_type' ) ) ) { 78 | return new WP_Error( 79 | 'rest_forbidden_context', 80 | __( 'Sorry, you are not allowed to list users.', 'authorship' ), 81 | [ 82 | 'status' => rest_authorization_required_code(), 83 | ] 84 | ); 85 | } 86 | 87 | if ( 88 | $request->get_param( 'slug' ) || 89 | $request->get_param( 'capabilities' ) || 90 | $request->get_param( 'who' ) || 91 | $request->get_param( 'roles' ) 92 | ) { 93 | return new WP_Error( 94 | 'rest_forbidden_context', 95 | __( 'Sorry, you are not allowed to filter users by this parameter.', 'authorship' ), 96 | [ 97 | 'status' => WP_Http::BAD_REQUEST, 98 | ] 99 | ); 100 | } 101 | 102 | if ( 'edit' === $request->get_param( 'context' ) ) { 103 | return new WP_Error( 104 | 'rest_forbidden_context', 105 | __( 'Sorry, you are not allowed to list users in the context of editing.', 'authorship' ), 106 | [ 107 | 'status' => WP_Http::BAD_REQUEST, 108 | ] 109 | ); 110 | } 111 | 112 | return true; 113 | } 114 | 115 | /** 116 | * Retrieves all users. 117 | * 118 | * @param WP_REST_Request $request Full details about the request. 119 | * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 120 | */ 121 | public function get_items( $request ) { 122 | add_filter( 'rest_user_query', [ $this, 'filter_rest_user_query' ], 10, 2 ); 123 | 124 | $items = parent::get_items( $request ); 125 | 126 | remove_filter( 'rest_user_query', [ $this, 'filter_rest_user_query' ] ); 127 | 128 | return $items; 129 | } 130 | 131 | /** 132 | * Filters WP_User_Query arguments when querying users via the REST API. 133 | * 134 | * @param mixed[] $prepared_args Array of arguments for WP_User_Query. 135 | * @param \WP_REST_Request $request The current request. 136 | * @return mixed[] Array of arguments for WP_User_Query. 137 | */ 138 | function filter_rest_user_query( array $prepared_args, \WP_REST_Request $request ) : array { 139 | unset( $prepared_args['has_published_posts'] ); 140 | 141 | return $prepared_args; 142 | } 143 | 144 | /** 145 | * Checks if a given request has access to create users. 146 | * 147 | * @param WP_REST_Request $request Full details about the request. 148 | * @return true|WP_Error True if the request has access to create items, WP_Error object otherwise. 149 | */ 150 | public function create_item_permissions_check( $request ) { 151 | if ( ! current_user_can( 'create_guest_authors' ) ) { 152 | return new WP_Error( 153 | 'rest_cannot_create_user', 154 | __( 'Sorry, you are not allowed to create guest authors.', 'authorship' ), 155 | [ 156 | 'status' => rest_authorization_required_code(), 157 | ] 158 | ); 159 | } 160 | 161 | if ( $request->get_param( 'email' ) && ! current_user_can( 'create_users' ) ) { 162 | return new WP_Error( 163 | 'rest_cannot_create_user_with_email', 164 | __( 'Sorry, you are not allowed to create guest authors with an email address.', 'authorship' ), 165 | [ 166 | 'status' => rest_authorization_required_code(), 167 | ] 168 | ); 169 | } 170 | 171 | if ( 172 | $request->get_param( 'roles' ) || 173 | $request->get_param( 'password' ) 174 | ) { 175 | return new WP_Error( 176 | 'rest_forbidden_context', 177 | __( 'Sorry, you are not allowed to provide this parameter when creating a guest author.', 'authorship' ), 178 | [ 179 | 'status' => WP_Http::FORBIDDEN, 180 | ] 181 | ); 182 | } 183 | 184 | return true; 185 | } 186 | 187 | /** 188 | * Creates a single user. 189 | * 190 | * @param WP_REST_Request $request Full details about the request. 191 | * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 192 | */ 193 | public function create_item( $request ) { 194 | $username = sanitize_title( sanitize_user( $request->get_param( 'name' ), true ) ); 195 | $username = preg_replace( '/[^a-z0-9]/', '', $username ); 196 | 197 | $request->set_param( 'username', $username ); 198 | 199 | /** 200 | * Filters the validated user registration details. 201 | * 202 | * @param array $result { 203 | * The array of user name, email, and the error messages. 204 | * 205 | * @type string $user_name Sanitized and unique username. 206 | * @type string $orig_username Original username. 207 | * @type string $user_email User email address. 208 | * @type WP_Error $errors WP_Error object containing any errors found. 209 | * } 210 | */ 211 | add_filter( 'wpmu_validate_user_signup', function( array $result ) : array { 212 | /** @var WP_Error $errors */ 213 | $errors = $result['errors']; 214 | $errors->remove( 'user_email' ); 215 | 216 | return $result; 217 | } ); 218 | 219 | return parent::create_item( $request ); 220 | } 221 | 222 | /** 223 | * Prepares a single user for creation or update. 224 | * 225 | * @param WP_REST_Request $request Request object. 226 | * @return object User object. 227 | */ 228 | protected function prepare_item_for_database( $request ) { 229 | $request->set_param( 'password', wp_generate_password( 24 ) ); 230 | 231 | if ( empty( $request->get_param( 'email' ) ) || ! current_user_can( 'create_users' ) ) { 232 | $request->set_param( 'email', '' ); 233 | } 234 | 235 | $request->set_param( 'roles', [ GUEST_ROLE ] ); 236 | 237 | return parent::prepare_item_for_database( $request ); 238 | } 239 | 240 | /** 241 | * Retrieves the user's schema, conforming to JSON Schema. 242 | * 243 | * @return mixed[] Item schema data. 244 | */ 245 | public function get_item_schema() { 246 | $schema = parent::get_item_schema(); 247 | 248 | $schema['properties']['email']['required'] = false; 249 | $schema['properties']['username']['required'] = false; 250 | $schema['properties']['password']['required'] = false; 251 | $schema['properties']['password']['readonly'] = true; 252 | 253 | $schema['properties']['name']['required'] = true; 254 | 255 | unset( 256 | $schema['properties']['capabilities'], 257 | $schema['properties']['description'], 258 | $schema['properties']['extra_capabilities'], 259 | $schema['properties']['url'] 260 | ); 261 | 262 | $this->schema = $schema; 263 | 264 | return $schema; 265 | } 266 | 267 | /** 268 | * Retrieves the query params for collections. 269 | * 270 | * @return mixed[] Collection parameters. 271 | */ 272 | public function get_collection_params() { 273 | $query_params = parent::get_collection_params(); 274 | 275 | $query_params['orderby']['enum'] = [ 276 | 'id', 277 | 'include', 278 | 'name', 279 | ]; 280 | 281 | $query_params['post_type'] = [ 282 | 'description' => __( 'Post type name.', 'authorship' ), 283 | 'type' => 'string', 284 | 'enum' => get_post_types( [ 285 | 'show_in_rest' => true, 286 | ] ), 287 | 'required' => true, 288 | ]; 289 | 290 | unset( 291 | $query_params['context'], 292 | $query_params['slug'], 293 | $query_params['capabilities'], 294 | $query_params['who'], 295 | $query_params['roles'] 296 | ); 297 | 298 | /** 299 | * Filters REST API collection parameters for the authorship users controller. 300 | * 301 | * This filter registers the collection parameter, but does not map the 302 | * collection parameter to an internal WP_User_Query parameter. 303 | * 304 | * Mimics the rest_user_collection_params from core's endpoint. 305 | * 306 | * @since 0.2.8 307 | * 308 | * @param array $query_params JSON Schema-formatted collection parameters. 309 | */ 310 | return apply_filters( 'authorship_rest_user_collection_params', $query_params ); 311 | } 312 | } 313 | -------------------------------------------------------------------------------- /inc/cli/class-migrate-command.php: -------------------------------------------------------------------------------- 1 | ] 34 | * : Perform a test run if true, make changes to the database if false. 35 | * --- 36 | * default: true 37 | * options: 38 | * - true 39 | * - false 40 | * --- 41 | * 42 | * [--overwrite-authors=] 43 | * : If true overwrite Authorship data with WP data, if false 44 | * skip posts that already have Authorship data. 45 | * --- 46 | * default: false 47 | * options: 48 | * - true 49 | * - false 50 | * --- 51 | * 52 | * [--post-type=] 53 | * : Post type, or comma separated list of post types. 54 | * --- 55 | * default: post 56 | * --- 57 | * 58 | * ## EXAMPLES 59 | * 60 | * wp authorship migrate wp-authors --dry-run=true 61 | * 62 | * @when after_wp_load 63 | * @subcommand wp-authors 64 | * 65 | * @param array $args CLI arguments 66 | * @param array $assoc_args CLI arguments 67 | */ 68 | public function wp_authors( $args, $assoc_args ) : void { 69 | $posts_per_page = 100; 70 | $paged = 1; 71 | $count = 0; 72 | 73 | // If --dry-run is not set, then it will default to true. 74 | // Must set --dry-run explicitly to false to run this command. 75 | $dry_run = filter_var( $assoc_args['dry-run'] ?? true, FILTER_VALIDATE_BOOLEAN ); 76 | 77 | if ( ! $dry_run ) { 78 | WP_CLI::warning( 'Dry run is disabled, data will be modified.' ); 79 | } 80 | 81 | // If --overwrite-authors is not set, then it will default to false. 82 | $overwrite = filter_var( $assoc_args['overwrite-authors'] ?? false, FILTER_VALIDATE_BOOLEAN ); 83 | 84 | if ( $overwrite ) { 85 | WP_CLI::warning( 'Overwriting of previous Authorship data is set to true.' ); 86 | } 87 | 88 | $post_types = explode( ',', $assoc_args['post-type'] ); 89 | WP_CLI::line( sprintf( 'Updating post types: %s', implode( ', ', $post_types ) ) ); 90 | 91 | $tax_query = $overwrite ? [] : [ 92 | [ 93 | 'taxonomy' => 'authorship', 94 | 'operator' => 'NOT EXISTS', 95 | ], 96 | ]; 97 | 98 | do { 99 | /** 100 | * @var array 101 | */ 102 | $posts = get_posts( [ 103 | 'posts_per_page' => $posts_per_page, 104 | 'paged' => $paged, 105 | 'post_type' => $post_types, 106 | 'post_status' => 'any', 107 | 'ignore_sticky_posts' => true, 108 | 'suppress_filters' => false, 109 | 'tax_query' => $tax_query, 110 | ] ); 111 | 112 | // Exit early if there are no more posts to avoid a final sleep call. 113 | if ( empty( $posts ) ) { 114 | break; 115 | } 116 | 117 | foreach ( $posts as $post ) { 118 | $authorship_authors = \Authorship\get_authors( $post ); 119 | 120 | if ( ! empty( $authorship_authors ) && ! $overwrite ) { 121 | // skip posts that already have authorship data. 122 | WP_CLI::line( 'Skipping post that already has Authorship data' ); 123 | continue; 124 | } 125 | 126 | // Set post author as Authorship author. 127 | if ( ! $dry_run ) { 128 | \Authorship\set_authors( $post, [ intval( $post->post_author ) ] ); 129 | } 130 | 131 | $count++; 132 | }//end foreach 133 | 134 | // Avoid memory exhaustion issues. 135 | $this->reset_local_object_cache(); 136 | 137 | // Pause for a moment to let the database catch up. 138 | WP_CLI::line( sprintf( 'Processed %d posts, pausing for a breath...', $count ) ); 139 | sleep( 2 ); 140 | 141 | $paged++; 142 | } while ( count( $posts ) ); 143 | 144 | if ( true === $dry_run ) { 145 | WP_CLI::success( sprintf( '%d posts would have had Authorship data added if this was not a dry run.', $count ) ); 146 | } else { 147 | WP_CLI::success( sprintf( '%d posts have had Authorship data added.', $count ) ); 148 | } 149 | } 150 | 151 | /** 152 | * Migrates PublishPress Authors data to Authorship. 153 | * 154 | * Running this creates new Authorship data, but does not remove PPA data 155 | * or perform cleanup. If the new Authorship data is not good, delete it 156 | * and re-run as PPA's data will still be there. 157 | * 158 | * Guest authors that aren't mapped to a user will have a user created 159 | * with the guest author role and the same name. 160 | * 161 | * ## OPTIONS 162 | * 163 | * [--dry-run=] 164 | * : Perform a test run if true, make changes to the database if false. 165 | * --- 166 | * default: true 167 | * options: 168 | * - true 169 | * - false 170 | * --- 171 | * 172 | * [--overwrite-authors=] 173 | * : If true overwrite Authorship data with publishpress data, if false 174 | * skip posts that already have Authorship data. 175 | * --- 176 | * default: false 177 | * options: 178 | * - true 179 | * - false 180 | * --- 181 | * 182 | * ## EXAMPLES 183 | * 184 | * wp authorship migrate ppa --dry-run=true 185 | * 186 | * @when after_wp_load 187 | * 188 | * @param array $args CLI arguments 189 | * @param array $assoc_args CLI arguments 190 | */ 191 | function ppa( $args, $assoc_args ) : void { 192 | if ( ! taxonomy_exists( 'author' ) ) { 193 | // register the `author` taxonomy so that we can query for PPA author terms. 194 | register_taxonomy( 'author', 'post' ); 195 | } 196 | 197 | $posts_per_page = 100; 198 | $paged = 1; 199 | $count = 0; 200 | 201 | // If --dry-run is not set, then it will default to true. 202 | // Must set --dry-run explicitly to false to run this command. 203 | $dry_run = filter_var( $assoc_args['dry-run'] ?? true, FILTER_VALIDATE_BOOLEAN ); 204 | 205 | if ( ! $dry_run ) { 206 | WP_CLI::warning( 'Dry run is disabled, data will be modified.' ); 207 | } 208 | 209 | // If --overwrite-authors is not set, then it will default to false. 210 | $overwrite = filter_var( $assoc_args['overwrite-authors'] ?? false, FILTER_VALIDATE_BOOLEAN ); 211 | 212 | if ( $overwrite ) { 213 | WP_CLI::warning( 'Overwriting of previous Authorship data is set to true.' ); 214 | } 215 | 216 | do { 217 | /** 218 | * @var array 219 | */ 220 | $posts = get_posts( [ 221 | 'posts_per_page' => $posts_per_page, 222 | 'paged' => $paged, 223 | 'post_status' => 'any', 224 | 'ignore_sticky_posts' => true, 225 | 'suppress_filters' => false, 226 | 'tax_query' => [ 227 | [ 228 | 'taxonomy' => 'author', 229 | 'operator' => 'EXISTS', 230 | ], 231 | ], 232 | ] ); 233 | 234 | // Exit early if there are no more posts to avoid a final sleep call. 235 | if ( empty( $posts ) ) { 236 | break; 237 | } 238 | 239 | foreach ( $posts as $post ) { 240 | $authorship_authors = \Authorship\get_authors( $post ); 241 | 242 | if ( ! empty( $authorship_authors ) && ! $overwrite ) { 243 | // skip posts that already have authorship data. 244 | WP_CLI::line( 'Skipping post that already has Authorship data' ); 245 | continue; 246 | } 247 | 248 | // check for PPA data. 249 | $ppa_terms = wp_get_object_terms( $post->ID, [ 'author' ] ); 250 | 251 | // if there are no Publish Press Authors data then there's 252 | // nothing to migrate, skip! 253 | if ( empty( $ppa_terms ) ) { 254 | WP_CLI::line( 'Skipping post with no PPA data' ); 255 | continue; 256 | } 257 | 258 | // If PPA is deactivated the terms can be an error object. 259 | // Usually invalid taxonomy, lets catch and report this. 260 | if ( is_wp_error( $ppa_terms ) ) { 261 | WP_CLI::error( 'There was an error fetching the PublishPress Author data, is the plugin activated?', false ); 262 | WP_CLI::error( $ppa_terms, false ); 263 | exit( 1 ); 264 | } 265 | 266 | /** 267 | * We're going to loop through all the PublishPress authors, 268 | * and get a list of user IDs to set in Authorship at the end. 269 | * If no user exists for the PPA guest author we create one. 270 | */ 271 | $new_authors = []; 272 | foreach ( $ppa_terms as $ppa_author ) { 273 | // add this user ID to the list of authors. 274 | $user_id = $this->get_ppa_user_id( $ppa_author, ! $dry_run ); 275 | 276 | // on dry runs the ID might be -1 if a user needed to be created. 277 | if ( $user_id !== -1 ) { 278 | $new_authors[] = $user_id; 279 | } 280 | } 281 | 282 | if ( empty( $new_authors ) ) { 283 | WP_CLI::line( 'Skipping post that has no multi-author data' ); 284 | continue; 285 | } 286 | 287 | if ( ! $dry_run ) { 288 | \Authorship\set_authors( $post, $new_authors ); 289 | } 290 | 291 | $count++; 292 | }//end foreach 293 | 294 | // Avoid memory exhaustion issues. 295 | $this->reset_local_object_cache(); 296 | 297 | // Pause for a moment to let the database catch up. 298 | WP_CLI::line( sprintf( 'Processed %d posts, pausing for a breath...', $count ) ); 299 | sleep( 2 ); 300 | 301 | $paged++; 302 | } while ( count( $posts ) ); 303 | 304 | if ( true === $dry_run ) { 305 | WP_CLI::success( sprintf( '%d posts would have had Authorship data added if this was not a dry run.', $count ) ); 306 | } else { 307 | WP_CLI::success( sprintf( '%d posts have had Authorship data added.', $count ) ); 308 | } 309 | } 310 | 311 | /** 312 | * Takes a PublishPress Author term and returns a user ID 313 | * for Authorship. 314 | * 315 | * @param WP_Term $ppa_author The term for the PPA author 316 | * @param boolean $create_users If false no users will be created if they are missing 317 | * 318 | * @return integer a user ID for this term, or -1 if not resolvable 319 | */ 320 | private function get_ppa_user_id( WP_Term $ppa_author, bool $create_users = false ) : int { 321 | /** 322 | * We need to get the user for Authorship so check if a 323 | * user is already mapped in PPA. 324 | */ 325 | $ppa_user_id = get_term_meta( $ppa_author->term_id, 'user_id', true ); 326 | 327 | // If there is no mapped PPA user then resolve that. 328 | if ( ! empty( $ppa_user_id ) ) { 329 | return intval( $ppa_user_id ); 330 | } 331 | 332 | /** 333 | * Look for one with the same username, our guest authors 334 | * will also use this slug to avoid duplication. 335 | * 336 | * @var WP_User|false 337 | */ 338 | $ppa_user = get_user_by( 'slug', $ppa_author->slug ); 339 | 340 | if ( ! empty( $ppa_user ) ) { 341 | return $ppa_user->ID; 342 | } 343 | 344 | // Return -1 unless we're allowed to create users. 345 | if ( $create_users !== true ) { 346 | return -1; 347 | } 348 | 349 | // If we still don't have a user, create a guest author, and 350 | // use the same approach as the REST API user controller for 351 | // the parameters. 352 | $args = [ 353 | 'user_login' => $ppa_author->slug, 354 | 'user_nicename' => $ppa_author->name, 355 | 'user_email' => '', 356 | 'user_pass' => wp_generate_password( 24 ), 357 | 'role' => GUEST_ROLE, 358 | ]; 359 | $ppa_user_id = wp_insert_user( $args ); 360 | 361 | // If this fails we want the debug data, so print out the 362 | // arguments so we can reproduce later. 363 | if ( is_wp_error( $ppa_user_id ) ) { 364 | WP_CLI::error( 'Could not create Authorship user with these arguments:', false ); 365 | WP_CLI::error( $ppa_user_id, false ); 366 | exit( 1 ); 367 | } 368 | 369 | return $ppa_user_id; 370 | } 371 | 372 | /** 373 | * Reset the local WordPress object cache. 374 | * 375 | * This only cleans the local cache in WP_Object_Cache, without 376 | * affecting memcache. 377 | * 378 | * Taken from VIP Go MU Plugins `vip_reset_local_object_cache`. 379 | * 380 | * @see https://github.com/Automattic/vip-go-mu-plugins/blob/master/vip-helpers/vip-caching.php#L733-L747 381 | */ 382 | private function reset_local_object_cache() : void { 383 | /** 384 | * @var WP_Object_Cache 385 | */ 386 | global $wp_object_cache; 387 | 388 | if ( ! is_object( $wp_object_cache ) ) { 389 | return; 390 | } 391 | 392 | if ( isset( $wp_object_cache->group_ops ) ) { 393 | $wp_object_cache->group_ops = []; 394 | } 395 | 396 | if ( isset( $wp_object_cache->memcache_debug ) ) { 397 | $wp_object_cache->memcache_debug = []; 398 | } 399 | 400 | if ( isset( $wp_object_cache->cache ) ) { 401 | $wp_object_cache->cache = []; 402 | } 403 | 404 | if ( method_exists( $wp_object_cache, '__remoteset' ) ) { 405 | // important! 406 | $wp_object_cache->__remoteset(); 407 | } 408 | } 409 | } 410 | -------------------------------------------------------------------------------- /inc/cli/namespace.php: -------------------------------------------------------------------------------- 1 | post_type ); 144 | $status_obj = get_post_status_object( $post->post_status ); 145 | 146 | if ( empty( $post_type ) || empty( $status_obj ) ) { 147 | return $caps; 148 | } 149 | 150 | if ( ! user_is_author( $user, $post ) ) { 151 | return $caps; 152 | } 153 | 154 | /** @var stdClass */ 155 | $post_type_cap = $post_type->cap; 156 | 157 | // Remove the following from `$caps`. 158 | $remove = [ 159 | 'delete' => [ 160 | $post_type_cap->delete_others_posts, 161 | $post_type_cap->delete_published_posts, 162 | $post_type_cap->delete_private_posts, 163 | ], 164 | 'edit' => [ 165 | $post_type_cap->edit_others_posts, 166 | $post_type_cap->edit_published_posts, 167 | $post_type_cap->edit_private_posts, 168 | ], 169 | 'read' => [ 170 | $post_type_cap->read_private_posts, 171 | ], 172 | ]; 173 | 174 | switch ( $cap ) { 175 | case 'delete_post': 176 | case 'delete_page': 177 | $caps = array_diff( $caps, $remove['delete'] ); 178 | 179 | // If the post is published or scheduled... 180 | if ( in_array( $post->post_status, [ 'publish', 'future' ], true ) ) { 181 | $caps[] = $post_type_cap->delete_published_posts; 182 | } elseif ( 'trash' === $post->post_status ) { 183 | $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true ); 184 | if ( in_array( $status, [ 'publish', 'future' ], true ) ) { 185 | $caps[] = $post_type_cap->delete_published_posts; 186 | } else { 187 | $caps[] = $post_type_cap->delete_posts; 188 | } 189 | } else { 190 | // If the post is draft... 191 | $caps[] = $post_type_cap->delete_posts; 192 | } 193 | break; 194 | case 'edit_post': 195 | case 'edit_page': 196 | $caps = array_diff( $caps, $remove['edit'] ); 197 | 198 | // If the post is published or scheduled... 199 | if ( in_array( $post->post_status, [ 'publish', 'future' ], true ) ) { 200 | $caps[] = $post_type_cap->edit_published_posts; 201 | } elseif ( 'trash' === $post->post_status ) { 202 | $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true ); 203 | if ( in_array( $status, [ 'publish', 'future' ], true ) ) { 204 | $caps[] = $post_type_cap->edit_published_posts; 205 | } else { 206 | $caps[] = $post_type_cap->edit_posts; 207 | } 208 | } else { 209 | // If the post is draft... 210 | $caps[] = $post_type_cap->edit_posts; 211 | } 212 | break; 213 | case 'read_post': 214 | case 'read_page': 215 | $caps = array_diff( $caps, $remove['read'] ); 216 | 217 | $caps[] = $post_type_cap->read; 218 | break; 219 | }//end switch 220 | 221 | return $caps; 222 | } 223 | 224 | /** 225 | * Filters a user's capabilities so they can be altered at runtime. 226 | * 227 | * @param bool[] $user_caps Array of key/value pairs where keys represent a capability name and boolean values 228 | * represent whether the user has that capability. 229 | * @param string[] $required_caps Array of required primitive capabilities for the requested capability. 230 | * @param mixed[] $args { 231 | * Arguments that accompany the requested capability check. 232 | * 233 | * @type string $0 Requested capability. 234 | * @type int $1 Concerned user ID. 235 | * @type mixed ...$2 Optional second and further parameters. 236 | * } 237 | * @param WP_User $user Concerned user object. 238 | * @return bool[] Array of concerned user's capabilities. 239 | */ 240 | function filter_user_has_cap( array $user_caps, array $required_caps, array $args, WP_User $user ) : array { 241 | $cap = $args[0]; 242 | 243 | switch ( $cap ) { 244 | 245 | case 'create_guest_authors': 246 | if ( ! array_key_exists( $cap, $user_caps ) ) { 247 | $user_caps[ $cap ] = user_can( $user->ID, 'edit_others_posts' ); 248 | } 249 | break; 250 | 251 | case 'attribute_post_type': 252 | if ( empty( $args[2] ) ) { 253 | $user_caps[ $cap ] = false; 254 | break; 255 | } 256 | 257 | $post_type_object = get_post_type_object( $args[2] ); 258 | 259 | if ( ! $post_type_object ) { 260 | $user_caps[ $cap ] = false; 261 | break; 262 | } 263 | 264 | if ( array_key_exists( $cap, $user_caps ) ) { 265 | break; 266 | } 267 | 268 | /** @var stdClass */ 269 | $post_type_caps = $post_type_object->cap; 270 | 271 | $user_caps[ $cap ] = user_can( $user->ID, $post_type_caps->edit_others_posts ); 272 | break; 273 | 274 | }//end switch 275 | 276 | return $user_caps; 277 | } 278 | 279 | /** 280 | * Fires once the WordPress environment has been set up. 281 | * 282 | * This is used to correct the `$authordata` global on author archives. 283 | * 284 | * @link https://core.trac.wordpress.org/ticket/44183 285 | * 286 | * @param WP $wp Current WordPress environment instance. 287 | */ 288 | function action_wp( WP $wp ) : void { 289 | if ( is_author() ) { 290 | $GLOBALS['authordata'] = get_userdata( get_query_var( 'author' ) ); 291 | } 292 | } 293 | 294 | /** 295 | * Fires after WordPress has finished loading but before any headers are sent. 296 | */ 297 | function register_roles_and_caps() : void { 298 | add_role( GUEST_ROLE, __( 'Guest Author', 'authorship' ), [] ); 299 | } 300 | 301 | /** 302 | * Filters the response immediately after executing any REST API callbacks. 303 | * 304 | * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $result Result to send to the client. Usually a WP_REST_Response or WP_Error. 305 | * @param mixed[] $handler Route handler used for the request. 306 | * @param WP_REST_Request $request Request used to generate the response. 307 | * @return WP_REST_Response|WP_HTTP_Response|WP_Error|mixed Result to send to the client. Usually a WP_REST_Response or WP_Error. 308 | */ 309 | function filter_rest_request_after_callbacks( $result, array $handler, WP_REST_Request $request ) { 310 | if ( ! ( $result instanceof WP_REST_Response ) ) { 311 | return $result; 312 | } 313 | 314 | $data = $result->get_data(); 315 | 316 | if ( ! is_array( $data ) || ! isset( $data[ REST_PARAM ] ) ) { 317 | return $result; 318 | } 319 | 320 | /** @var int $author */ 321 | foreach ( $data[ REST_PARAM ] as $author ) { 322 | $result->add_link( 323 | REST_LINK_ID, 324 | sprintf( 325 | rest_url( 'wp/v2/users/%d' ), 326 | $author 327 | ), 328 | [ 329 | 'embeddable' => true, 330 | ] 331 | ); 332 | } 333 | 334 | return $result; 335 | } 336 | 337 | /** 338 | * Adds the authorship field to the REST API for post objects. 339 | * 340 | * @param WP_REST_Server $server Server object. 341 | */ 342 | function register_rest_api_fields( WP_REST_Server $server ) : void { 343 | $post_types = get_supported_post_types(); 344 | 345 | array_walk( $post_types, __NAMESPACE__ . '\\register_rest_api_field' ); 346 | 347 | $users_controller = new Users_Controller; 348 | $users_controller->register_routes(); 349 | } 350 | 351 | /** 352 | * Validates a passed REST API argument for the list of authors. 353 | * 354 | * @param mixed $authors The passed value. 355 | * @param WP_REST_Request $request The REST API request object. 356 | * @param string $param The param name. 357 | * @param string $post_type The post type name. 358 | * @return WP_Error|null Null if the validation passes, `WP_Error` instance otherwise. 359 | */ 360 | function validate_authors( $authors, WP_REST_Request $request, string $param, string $post_type ) :? WP_Error { 361 | $schema_validation = rest_validate_request_arg( $authors, $request, $param ); 362 | 363 | if ( is_wp_error( $schema_validation ) ) { 364 | return $schema_validation; 365 | } 366 | 367 | if ( ! current_user_can( 'attribute_post_type', $post_type ) ) { 368 | return new WP_Error( 'authorship', __( 'You are not allowed to set the attributed authors of this post.', 'authorship' ), [ 369 | 'status' => WP_Http::FORBIDDEN, 370 | ] ); 371 | } 372 | 373 | if ( ! is_post_type_supported( $post_type ) ) { 374 | return new WP_Error( 'authorship', __( 'This post type does not support attributed authors.', 'authorship' ), [ 375 | 'status' => WP_Http::BAD_REQUEST, 376 | ] ); 377 | } 378 | 379 | // The REST API accepts and coerces a comma-separated string as an array, so 380 | // we need to allow for that here. 381 | $authors = wp_parse_id_list( $authors ); 382 | 383 | /** @var WP_User[] */ 384 | $users = get_users( [ 385 | // Check all sites. 386 | 'blog_id' => 0, 387 | 'include' => $authors, 388 | 'orderby' => 'include', 389 | ] ); 390 | 391 | if ( count( $users ) !== count( $authors ) ) { 392 | return new WP_Error( 'authorship', __( 'One or more user IDs are not valid for this site.', 'authorship' ), [ 393 | 'status' => WP_Http::BAD_REQUEST, 394 | ] ); 395 | } 396 | 397 | return null; 398 | } 399 | 400 | /** 401 | * Register the Authorship REST API field for the given post type. 402 | * 403 | * @param string $post_type The post type name. 404 | */ 405 | function register_rest_api_field( string $post_type ) : void { 406 | $validate_callback = function( $authors, WP_REST_Request $request, string $param ) use ( $post_type ) :? WP_Error { 407 | return validate_authors( $authors, $request, $param, $post_type ); 408 | }; 409 | 410 | register_rest_field( $post_type, REST_PARAM, [ 411 | 'get_callback' => function( array $post ) : array { 412 | $post = get_post( $post['id'] ); 413 | 414 | if ( ! $post ) { 415 | return []; 416 | } 417 | 418 | return array_map( function( WP_User $user ) : int { 419 | return $user->ID; 420 | }, get_authors( $post ) ); 421 | }, 422 | 'update_callback' => function( $value, WP_Post $post, string $field, WP_REST_Request $request, string $post_type ) :? WP_Error { 423 | try { 424 | set_authors( $post, wp_parse_id_list( $value ) ); 425 | } catch ( Exception $e ) { 426 | return new WP_Error( 'authorship', $e->getMessage(), [ 427 | 'status' => WP_Http::BAD_REQUEST, 428 | ] ); 429 | } 430 | 431 | return null; 432 | }, 433 | 'schema' => [ 434 | 'description' => __( 'Authors', 'authorship' ), 435 | 'type' => 'array', 436 | 'items' => [ 437 | 'type' => 'integer', 438 | ], 439 | 'arg_options' => [ 440 | 'validate_callback' => $validate_callback, 441 | ], 442 | ], 443 | ] ); 444 | 445 | add_filter( "rest_prepare_{$post_type}", __NAMESPACE__ . '\\rest_prepare_post', 10, 3 ); 446 | } 447 | 448 | /** 449 | * Filters the post data for a REST API response. 450 | * 451 | * This removes the `wp:action-assign-author` rel from the response so the default post author 452 | * control doesn't get shown on the block editor post editing screen. 453 | * 454 | * This also adds a new `authorship:action-assign-authorship` rel so custom clients can refer to this. 455 | * 456 | * @param WP_REST_Response $response The response object. 457 | * @param WP_Post $post Post object. 458 | * @param WP_REST_Request $request Request object. 459 | * @return WP_REST_Response The response object. 460 | */ 461 | function rest_prepare_post( WP_REST_Response $response, WP_Post $post, WP_REST_Request $request ) : WP_REST_Response { 462 | $links = $response->get_links(); 463 | 464 | if ( isset( $links['https://api.w.org/action-assign-author'] ) ) { 465 | $response->remove_link( 'https://api.w.org/action-assign-author' ); 466 | $response->add_link( REST_REL_LINK_ID, $links['self'][0]['href'] ); 467 | } 468 | 469 | return $response; 470 | } 471 | 472 | /** 473 | * Filters extra CURIEs available on REST API responses. 474 | * 475 | * @param array[] $additional Additional CURIEs to register with the API. 476 | * @return array[] Additional CURIEs to register with the API. 477 | */ 478 | function filter_rest_response_link_curies( array $additional ) : array { 479 | $additional[] = [ 480 | 'name' => REST_PARAM, 481 | 'href' => REST_CURIE_TEMPLATE, 482 | 'templated' => true, 483 | ]; 484 | 485 | return $additional; 486 | } 487 | 488 | /** 489 | * Fires after block assets have been enqueued for the editing interface. 490 | */ 491 | function enqueue_assets() : void { 492 | /** @var WP_Post|null */ 493 | $post = get_post(); 494 | 495 | if ( ! $post || ! is_post_type_supported( $post->post_type ) ) { 496 | return; 497 | } 498 | 499 | enqueue_assets_for_post(); 500 | preload_author_data( $post ); 501 | } 502 | 503 | /** 504 | * Enqueues the JS and CSS assets for the author selection control. 505 | */ 506 | function enqueue_assets_for_post() : void { 507 | $manifest = plugin_dir_path( __DIR__ ) . 'build/asset-manifest.json'; 508 | 509 | enqueue_asset( 510 | $manifest, 511 | 'main.js', 512 | [ 513 | 'handle' => SCRIPT_HANDLE, 514 | // @TODO check: 515 | 'dependencies' => [ 516 | 'react', 517 | 'wp-block-editor', 518 | 'wp-blocks', 519 | 'wp-components', 520 | 'wp-element', 521 | 'wp-i18n', 522 | 'wp-polyfill', 523 | ], 524 | ] 525 | ); 526 | 527 | enqueue_asset( 528 | $manifest, 529 | 'style.css', 530 | [ 531 | 'handle' => STYLE_HANDLE, 532 | ] 533 | ); 534 | } 535 | 536 | /** 537 | * Preloads author data for the post editing screen. 538 | * 539 | * @param WP_Post $post The post being edited. 540 | */ 541 | function preload_author_data( WP_Post $post ) : void { 542 | $authors = get_authors( $post ); 543 | 544 | if ( empty( $authors ) ) { 545 | $authors = [ 546 | wp_get_current_user(), 547 | ]; 548 | } 549 | 550 | $authors = array_map( function( WP_User $user ) { 551 | $avatar = get_avatar_url( $user->ID ); 552 | 553 | return [ 554 | 'value' => $user->ID, 555 | 'label' => $user->display_name, 556 | 'avatar' => $avatar ? $avatar : null, 557 | ]; 558 | }, $authors ); 559 | 560 | wp_localize_script( 561 | SCRIPT_HANDLE, 562 | 'authorshipData', 563 | [ 564 | 'authors' => $authors, 565 | ] 566 | ); 567 | } 568 | 569 | /** 570 | * Fires after the query variable object is created, but before the actual query is run. 571 | * 572 | * This is used to override author-related query vars with a corresponding taxonomy query and 573 | * then add a second filter that resets the vars after the query has run. 574 | * 575 | * @param WP_Query $query The WP_Query instance. 576 | */ 577 | function action_pre_get_posts( WP_Query $query ) : void { 578 | $post_type = $query->get( 'post_type' ); 579 | 580 | if ( empty( $post_type ) ) { 581 | // @TODO this needs more work so it matches the behaviour of the internals of `WP_Query`. 582 | $post_type = 'post'; 583 | } 584 | 585 | if ( array_diff( (array) $post_type, get_supported_post_types() ) ) { 586 | // If _any_ of the requested post types don't support `author`, let the default query run. 587 | // @TODO I don't think anything can be done about a query for multiple post types where one or 588 | // more support `author` and one or more don't. 589 | return; 590 | } 591 | 592 | $stored_values = []; 593 | 594 | // Different query args and their default values. 595 | $concerns = [ 596 | 'author_name' => '', 597 | 'author' => '', 598 | 'author__in' => [], 599 | 'author__not_in' => [], 600 | ]; 601 | 602 | // Record the original values of concerned query vars and remove them from the query. 603 | foreach ( $concerns as $concern => $concern_default_value ) { 604 | $value = $query->get( $concern ); 605 | if ( ! empty( $value ) ) { 606 | $stored_values[ $concern ] = $value; 607 | $query->set( $concern, $concern_default_value ); 608 | } 609 | } 610 | 611 | // None of the set query vars concern us? Then we have nothing more to do. 612 | if ( empty( $stored_values ) ) { 613 | return; 614 | } 615 | 616 | $user_ids = [ 0 ]; 617 | 618 | // Get a user ID from either `author` or `author_name`. The ID doesn't have to be valid 619 | // as WP_Query will handle the validation before constructing its query. 620 | if ( ! empty( $stored_values['author'] ) ) { 621 | if ( is_string( $stored_values['author'] ) ) { 622 | $user_ids = array_map( 'intval', explode( ',', $stored_values['author'] ) ); 623 | } elseif ( is_numeric( $stored_values['author'] ) ) { 624 | $user_ids = [ (int) $stored_values['author'] ]; 625 | } 626 | } elseif ( ! empty( $stored_values['author_name'] ) ) { 627 | $user = get_user_by( 'slug', $stored_values['author_name'] ); 628 | 629 | if ( $user ) { 630 | $user_ids = [ $user->ID ]; 631 | } 632 | } elseif ( ! empty( $stored_values['author__in'] ) ) { 633 | $user_ids = array_map( 'intval', $stored_values['author__in'] ); 634 | } elseif ( ! empty( $stored_values['author__not_in'] ) ) { 635 | $user_ids = array_map( function( int $id ) : int { 636 | return $id * -1; 637 | }, array_map( 'intval', $stored_values['author__not_in'] ) ); 638 | } 639 | 640 | $tax_query = $query->get( 'tax_query' ); 641 | 642 | // Record the value of an existing tax query, if there is one. 643 | $stored_values['tax_query'] = $tax_query; 644 | 645 | if ( empty( $tax_query ) ) { 646 | $tax_query = []; 647 | } 648 | 649 | // Add a corresponding tax query that queries for posts with terms with a slug matching the requested user ID. 650 | $tax_query[] = [ 651 | 'taxonomy' => TAXONOMY, 652 | 'terms' => array_map( 'absint', $user_ids ), 653 | 'field' => 'slug', 654 | // negative values meant NOT IN rather than IN. 655 | 'operator' => current( $user_ids ) >= 0 ? 'IN' : 'NOT IN', 656 | ]; 657 | 658 | $query->set( 'tax_query', $tax_query ); 659 | 660 | /** 661 | * Filters the posts array before the query takes place. 662 | * 663 | * This allows the query vars to be reset to their original values. 664 | * 665 | * @param WP_Post[]|null $posts Array of post objects. Passed by reference. 666 | * @param WP_Query $query The WP_Query instance. 667 | */ 668 | add_filter( 'posts_pre_query', function( ?array $posts, WP_Query $query ) use ( &$stored_values, $user_ids ) : ?array { 669 | if ( empty( $stored_values ) ) { 670 | return $posts; 671 | } 672 | 673 | // Reset the query vars to their original values. 674 | foreach ( $stored_values as $concern => $value ) { 675 | $query->set( $concern, $value ); 676 | } 677 | 678 | // Specifically set `author` when `author_name` is in use as WP_Query also sets `author` internally. 679 | if ( ! empty( $stored_values['author_name'] ) ) { 680 | $query->set( 'author', $user_ids[0] ); 681 | } 682 | 683 | // Clear the recorded values so subsequent queries are not affected. 684 | $stored_values = []; 685 | 686 | return $posts; 687 | }, 999, 2 ); 688 | } 689 | 690 | /** 691 | * Filters the list of recipients for comment moderation emails. 692 | * 693 | * @param string[] $emails List of email addresses to notify for comment moderation. 694 | * @param int $comment_id Comment ID. 695 | * @return string[] List of email addresses to notify for comment moderation. 696 | */ 697 | function filter_comment_moderation_recipients( array $emails, int $comment_id ) : array { 698 | /** @var \WP_Comment */ 699 | $comment = get_comment( $comment_id ); 700 | $post_id = (int) $comment->comment_post_ID; 701 | 702 | if ( ! $post_id ) { 703 | return $emails; 704 | } 705 | 706 | $post = get_post( $post_id ); 707 | 708 | if ( ! ( $post instanceof WP_Post ) ) { 709 | return $emails; 710 | } 711 | 712 | $authors = get_authors( $post ); 713 | 714 | $moderators = array_filter( $authors, function( WP_User $user ) use ( $comment ) : bool { 715 | return user_can( $user->ID, 'edit_comment', $comment->comment_ID ); 716 | } ); 717 | 718 | $additional_emails = array_filter( array_map( function( WP_User $user ) : string { 719 | return $user->user_email; 720 | }, $moderators ) ); 721 | 722 | return array_unique( array_merge( $emails, $additional_emails ) ); 723 | } 724 | 725 | /** 726 | * Filters the list of email addresses to receive a comment notification. 727 | * 728 | * @param string[] $emails An array of email addresses to receive a comment notification. 729 | * @param int $comment_id The comment ID. 730 | * @return string[] An array of email addresses to receive a comment notification. 731 | */ 732 | function filter_comment_notification_recipients( array $emails, int $comment_id ) : array { 733 | /** @var \WP_Comment */ 734 | $comment = get_comment( $comment_id ); 735 | $post_id = (int) $comment->comment_post_ID; 736 | 737 | if ( ! $post_id ) { 738 | return $emails; 739 | } 740 | 741 | $post = get_post( $post_id ); 742 | 743 | if ( ! ( $post instanceof WP_Post ) ) { 744 | return $emails; 745 | } 746 | 747 | $authors = get_authors( $post ); 748 | 749 | /** @var string[] */ 750 | $additional_emails = array_filter( array_map( function( WP_User $user ) : string { 751 | return $user->user_email; 752 | }, $authors ) ); 753 | 754 | return array_unique( array_merge( $emails, $additional_emails ) ); 755 | } 756 | 757 | /** 758 | * Hide author select from quick edit. 759 | * 760 | * Bit of a hack, but filter filter_quickedit_authors and include only author with ID 0. 761 | * Also hide if only one author just in case someone someone has created author with 0. 762 | * 763 | * @param array $options Options. 764 | * @return array Filtered options. 765 | */ 766 | function hide_quickedit_authors( array $options ) : array { 767 | $options['hide_if_only_one_author'] = true; 768 | $options['include'] = [ 0 ]; 769 | return $options; 770 | } 771 | -------------------------------------------------------------------------------- /inc/taxonomy.php: -------------------------------------------------------------------------------- 1 | false, 27 | 'sort' => true, 28 | 'args' => [ 29 | 'orderby' => 'term_order', 30 | 'order' => 'ASC', 31 | ], 32 | 'public' => false, 33 | 'show_in_rest' => false, 34 | 'capabilities' => [ 35 | 'manage_terms' => 'edit_posts', 36 | 'edit_terms' => 'edit_posts', 37 | 'delete_terms' => 'edit_posts', 38 | 'assign_terms' => 'edit_posts', 39 | ], 40 | 'labels' => [ 41 | 'name' => __( 'Authors', 'authorship' ), 42 | 'singular_name' => _x( 'Author', 'taxonomy general name', 'authorship' ), 43 | 'search_items' => __( 'Search authors', 'authorship' ), 44 | 'popular_items' => __( 'Popular authors', 'authorship' ), 45 | 'all_items' => __( 'All authors', 'authorship' ), 46 | 'parent_item' => __( 'Parent Author', 'authorship' ), 47 | 'parent_item_colon' => __( 'Parent Author:', 'authorship' ), 48 | 'edit_item' => __( 'Edit Author', 'authorship' ), 49 | 'update_item' => __( 'Update Author', 'authorship' ), 50 | 'view_item' => __( 'View Author', 'authorship' ), 51 | 'add_new_item' => __( 'Add New Author', 'authorship' ), 52 | 'new_item_name' => __( 'New Author', 'authorship' ), 53 | 'separate_items_with_commas' => __( 'Separate authors with commas', 'authorship' ), 54 | 'add_or_remove_items' => __( 'Add or remove authors', 'authorship' ), 55 | 'choose_from_most_used' => __( 'Choose from the most used authors', 'authorship' ), 56 | 'not_found' => __( 'No authors found.', 'authorship' ), 57 | 'no_terms' => __( 'No authors', 'authorship' ), 58 | 'menu_name' => __( 'Authors', 'authorship' ), 59 | 'items_list_navigation' => __( 'Authors list navigation', 'authorship' ), 60 | 'items_list' => __( 'Authors list', 'authorship' ), 61 | 'most_used' => _x( 'Most Used', 'author', 'authorship' ), 62 | 'back_to_items' => __( '← Back to authors', 'authorship' ), 63 | ], 64 | ] 65 | ); 66 | 67 | $user_id = get_current_user_id(); 68 | 69 | $term = get_term_by( 'slug', $user_id, TAXONOMY ); 70 | if ( $term instanceof WP_Term ) { 71 | $count = $term->count; 72 | 73 | $text = sprintf( 74 | /* translators: %s: Number of posts. */ 75 | _nx( 76 | 'Mine (%s)', 77 | 'Mine (%s)', 78 | $count, 79 | 'posts', 80 | 'authorship' 81 | ), 82 | number_format_i18n( $count ) 83 | ); 84 | } else { 85 | $text = ''; 86 | } 87 | 88 | foreach ( $post_types as $post_type ) { 89 | /** 90 | * Filters the list of available list table views. 91 | * 92 | * @param string[] $views An array of available list table views. 93 | * @return string[] An array of available list table views. 94 | */ 95 | add_filter( "views_edit-{$post_type}", function( array $views ) use ( $post_type, $text, $user_id ) : array { 96 | if ( ! $text ) { 97 | unset( $views['mine'] ); 98 | 99 | return $views; 100 | } 101 | 102 | $args = [ 103 | 'post_type' => $post_type, 104 | 'author' => $user_id, 105 | ]; 106 | $link = add_query_arg( $args, admin_url( 'edit.php' ) ); 107 | 108 | $views['mine'] = sprintf( 109 | '%2$s', 110 | $link, 111 | $text 112 | ); 113 | 114 | return $views; 115 | } ); 116 | }//end foreach 117 | } 118 | -------------------------------------------------------------------------------- /inc/template.php: -------------------------------------------------------------------------------- 1 | post_type ) ) { 25 | if ( post_type_supports( $post->post_type, 'author' ) ) { 26 | return [ intval( $post->post_author ) ]; 27 | } 28 | 29 | return []; 30 | } 31 | 32 | $authors = wp_get_post_terms( $post->ID, TAXONOMY ); 33 | if ( is_wp_error( $authors ) ) { 34 | return []; 35 | } 36 | 37 | return array_map( function ( WP_Term $term ) : int { 38 | return intval( $term->slug ); 39 | }, $authors ); 40 | } 41 | 42 | /** 43 | * Returns the user objects for the attributed author(s) of the given post. 44 | * 45 | * @param WP_Post $post The post object. 46 | * @return WP_User[] Array of user objects. 47 | */ 48 | function get_authors( WP_Post $post ) : array { 49 | $author_ids = get_author_ids( $post ); 50 | if ( empty( $author_ids ) ) { 51 | return []; 52 | } 53 | 54 | /** @var WP_User[] */ 55 | $users = get_users( [ 56 | // Check all sites. 57 | 'blog_id' => 0, 58 | 'include' => $author_ids, 59 | 'orderby' => 'include', 60 | ] ); 61 | 62 | return $users; 63 | } 64 | 65 | /** 66 | * Returns a comma-separated list of the names of the attributed author(s) of the given post. 67 | * 68 | * Example: 69 | * 70 | * John Lennon, Paul McCartney, George Harrison, Ringo Starr 71 | * 72 | * @param WP_Post $post The post object. 73 | * @return string List of the names of the authors. 74 | */ 75 | function get_author_names( WP_Post $post ) : string { 76 | $authors = get_authors( $post ); 77 | 78 | return implode( ', ', array_column( $authors, 'display_name' ) ); 79 | } 80 | 81 | /** 82 | * Returns a sentence stating the names of the attributed author(s) of the given post, localised 83 | * to the current language. 84 | * 85 | * Example: 86 | * 87 | * Mick Jagger, Keith Richards, Charlie Watts, and Ronnie Wood 88 | * 89 | * @param WP_Post $post The post object. 90 | * @return string List of the names of the authors. 91 | */ 92 | function get_author_names_sentence( WP_Post $post ) : string { 93 | $authors = get_authors( $post ); 94 | 95 | if ( empty( $authors ) ) { 96 | return ''; 97 | } 98 | 99 | return wp_sprintf( 100 | '%l', 101 | array_column( $authors, 'display_name' ) 102 | ); 103 | } 104 | 105 | /** 106 | * Returns an unordered HTML list of the names of the attributed author(s) of the given post, 107 | * linked to their author archive. 108 | * 109 | * Example: 110 | * 111 | * 115 | * 116 | * @param WP_Post $post The post object. 117 | * @return string List of the names of the authors. 118 | */ 119 | function get_author_names_list( WP_Post $post ) : string { 120 | $authors = get_authors( $post ); 121 | 122 | if ( empty( $authors ) ) { 123 | return ''; 124 | } 125 | 126 | $list = array_reduce( $authors, function( string $carry, WP_User $author ) { 127 | return "{$carry}\n\t" . sprintf( 128 | '
  • %2$s
    • ', 129 | esc_url( get_author_posts_url( $author->ID ) ), 130 | esc_html( $author->display_name ) 131 | ); 132 | }, '' ); 133 | 134 | $output = <<{$list} 136 | 137 | HTML; 138 | 139 | return $output; 140 | } 141 | 142 | /** 143 | * Sets the attributed authors for the given post. 144 | * 145 | * @param WP_Post $post The post object. 146 | * @param int[] $authors Array of user IDs. 147 | * @throws Exception If any of the users do not exist. 148 | * @return WP_User[] Array of user objects. 149 | */ 150 | function set_authors( WP_Post $post, array $authors ) : array { 151 | if ( ! is_post_type_supported( $post->post_type ) ) { 152 | throw new Exception( __( 'This post type does not support authorship.', 'authorship' ) ); 153 | } 154 | 155 | /** @var int[] $authors */ 156 | $authors = array_filter( array_map( 'intval', $authors ) ); 157 | 158 | /** @var WP_User[] */ 159 | $users = get_users( [ 160 | // Check all sites. 161 | 'blog_id' => 0, 162 | 'include' => $authors, 163 | 'orderby' => 'include', 164 | ] ); 165 | 166 | if ( count( $users ) !== count( $authors ) ) { 167 | throw new Exception( __( 'One or more user IDs are not valid for this site.', 'authorship' ) ); 168 | } 169 | 170 | // Author IDs must be mapped to strings before passing to `wp_set_post_terms()`. 171 | $terms = wp_set_post_terms( $post->ID, array_map( 'strval', $authors ), TAXONOMY ); 172 | 173 | if ( is_wp_error( $terms ) ) { 174 | throw new Exception( $terms->get_error_message() ); 175 | } 176 | 177 | return $users; 178 | } 179 | 180 | /** 181 | * Determines if the given user is an attributed author of the given post. 182 | * 183 | * @param WP_User $user The user object. 184 | * @param WP_Post $post The post object. 185 | * @return bool Whether the user is an attributed author of the post. 186 | */ 187 | function user_is_author( WP_User $user, WP_Post $post ) : bool { 188 | if ( ! is_post_type_supported( $post->post_type ) ) { 189 | return ( intval( $post->post_author ) === $user->ID ); 190 | } 191 | 192 | $author_ids = get_author_ids( $post ); 193 | 194 | return in_array( $user->ID, $author_ids, true ); 195 | } 196 | -------------------------------------------------------------------------------- /plugin.php: -------------------------------------------------------------------------------- 1 | void, 25 | onUpdate: ( value: number[] ) => void, 26 | postType: string, 27 | preloadedAuthorOptions: authorshipDataFromWP, 28 | } 29 | 30 | /** 31 | * Creates an option from a REST API user response. 32 | * 33 | * @param {WP_REST_API_User} user The user object. 34 | * @returns {Option} The option object. 35 | */ 36 | const createOption = ( user: WP_REST_API_User ): Option => ( { 37 | value: user.id, 38 | label: user.name, 39 | avatar: user?.avatar_urls?.[48] || null, 40 | } ); 41 | 42 | const getHelperContainer = (): HTMLElement => document.querySelector( `.${ containerClassName}` ); 43 | 44 | /** 45 | * Returns the author selector control. 46 | * 47 | * @param {AuthorsSelectProps} props Component props. 48 | * @returns {ReactElement} An element. 49 | */ 50 | const AuthorsSelect = ( props: AuthorsSelectProps ): ReactElement => { 51 | const { currentAuthorIDs, hasAssignAuthorAction, onError, onUpdate, postType, preloadedAuthorOptions } = props; 52 | 53 | const isDisabled = ! hasAssignAuthorAction; 54 | 55 | const [ selected, setSelected ] = useState( [] ); 56 | 57 | const preloadedAuthorIDs = preloadedAuthorOptions.authors.map( author => author.value ); 58 | 59 | if ( ! selected.length && isEqual( preloadedAuthorIDs, currentAuthorIDs ) ) { 60 | setSelected( preloadedAuthorOptions.authors ); 61 | } else if ( currentAuthorIDs !== undefined && currentAuthorIDs.length && ! selected.length ) { 62 | 63 | const path = addQueryArgs( 64 | '/authorship/v1/users/', 65 | { 66 | include: currentAuthorIDs, 67 | orderby: 'include', 68 | post_type: postType, 69 | } 70 | ); 71 | 72 | const api: Promise = apiFetch( { path } ); 73 | 74 | api.then( users => { 75 | setSelected( users.map( createOption ) ); 76 | } ).catch( ( error: WP_REST_API_Error ) => { 77 | onError( error.message ); 78 | } ); 79 | } 80 | 81 | /** 82 | * Asynchronously loads the options for the control based on the search parameter. 83 | * 84 | * @param {string} search The search string. 85 | * @returns {Promise} A promise that fulfils the options. 86 | */ 87 | const loadOptions = ( search: string ): Promise => { 88 | const path = addQueryArgs( 89 | '/authorship/v1/users/', 90 | { 91 | search, 92 | post_type: postType, 93 | } 94 | ); 95 | 96 | const api: Promise = apiFetch( { path } ); 97 | 98 | return api.then( users => 99 | users.map( createOption ) 100 | ).catch( ( error: WP_REST_API_Error ) => { 101 | onError( error.message ); 102 | return []; 103 | } ); 104 | }; 105 | 106 | /** 107 | * Declares styles for elements that can't easily be targeted with a CSS selector. 108 | */ 109 | const styles: Styles = { 110 | input: () => ( { 111 | margin: 0, 112 | width: '100%', 113 | } ), 114 | }; 115 | 116 | /** 117 | * Handles changes to the selected authors. 118 | * 119 | * @param {Option[]} [options] The selected options. 120 | */ 121 | const changeValue = ( options?: Option[] ) => { 122 | setSelected( options || [] ); 123 | onUpdate( options ? ( options.map( option => option.value ) ) : [] ); 124 | }; 125 | 126 | /** 127 | * Handles the creation of a new guest author. 128 | * 129 | * @param {string} option The new option. 130 | */ 131 | const onCreateOption = ( option: string ) => { 132 | const path = addQueryArgs( 133 | '/authorship/v1/users/', 134 | { 135 | name: option, 136 | } 137 | ); 138 | 139 | const api: Promise = apiFetch( { 140 | method: 'POST', 141 | path, 142 | } ); 143 | 144 | return api.then( user => { 145 | const options = [ ...selected, createOption( user ) ]; 146 | 147 | setSelected( options ); 148 | onUpdate( options.map( option => option.value ) ); 149 | } ).catch( ( error: WP_REST_API_Error ) => { 150 | onError( error.message ); 151 | } ); 152 | }; 153 | 154 | /** 155 | * Fired when option sorting ends. Updates the component state and calls the update callback. 156 | * 157 | * @param {SortedOption} option Sorting information for the option. 158 | */ 159 | const onSortEnd = ( option: SortedOption ) => { 160 | const value = arrayMove( selected, option.oldIndex, option.newIndex ); 161 | setSelected( value ); 162 | onUpdate( value.map( option => option.value ) ); 163 | }; 164 | 165 | return ( 166 | 180 | ); 181 | }; 182 | 183 | const mapDispatchToProps = ( dispatch: CallableFunction ): Record => ( { 184 | onError( message: string ) { 185 | dispatch( 'core/notices' ).createErrorNotice( message ); 186 | }, 187 | onUpdate( value: number[] ) { 188 | dispatch( 'core/editor' ).editPost( { 189 | authorship: value, 190 | } ); 191 | }, 192 | } ); 193 | 194 | const mapSelectToProps = ( select: CallableFunction ): Record => ( { 195 | currentAuthorIDs: select( 'core/editor' ).getEditedPostAttribute( 'authorship' ), 196 | postType: select( 'core/editor' ).getCurrentPostType(), 197 | preloadedAuthorOptions: authorshipData, 198 | hasAssignAuthorAction: Boolean( get( 199 | select( 'core/editor' ).getCurrentPost(), 200 | [ '_links', 'authorship:action-assign-authorship' ], 201 | false 202 | ) ), 203 | } ); 204 | 205 | export default compose( [ 206 | withDispatch( mapDispatchToProps ), 207 | withSelect( mapSelectToProps ), 208 | ] )( AuthorsSelect ); 209 | -------------------------------------------------------------------------------- /src/components/SortableMultiValueElement.tsx: -------------------------------------------------------------------------------- 1 | import React, { ReactElement } from 'react'; 2 | import { components, MultiValueProps } from 'react-select'; 3 | import { SortableElement } from 'react-sortable-hoc'; 4 | 5 | import { Option } from '../types'; 6 | 7 | const { MultiValue } = components; 8 | 9 | const MultiValueElement = ( props: MultiValueProps