-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Knowledge: Introduce the wp_knowledge custom post type
#12201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gziolo
wants to merge
7
commits into
WordPress:trunk
Choose a base branch
from
gziolo:feature/knowledge-cpt
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d008aaa
Knowledge: Introduce the wp_knowledge custom post type.
gziolo 32cfc1d
Knowledge: Address PR feedback on naming and capability filter.
gziolo ce880e5
Knowledge: Use plural/singular capability bases per convention.
gziolo 782e260
Knowledge: Strengthen REST controller permission test coverage.
gziolo bc904a0
Knowledge: Keep author control of their own trashed rows.
gziolo 71f5938
Knowledge: Align the collection read error code with core controllers.
gziolo a531231
Knowledge: Drop the no-op show_admin_column from wp_knowledge_type.
gziolo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| <?php | ||
| /** | ||
| * Knowledge API: Public functions for the `wp_knowledge` post type. | ||
| * | ||
| * The Knowledge post type is a private-by-default storage primitive. Individual | ||
| * rows are classified by one or more terms in the `wp_knowledge_type` taxonomy | ||
| * (for example "guideline", "memory", or "note"). This file holds the type | ||
| * registry, the default-term fallback applied on save, and the helper that | ||
| * gives lazily created type terms a human-readable label. | ||
| * | ||
| * @package WordPress | ||
| * @subpackage Knowledge | ||
| * @since 7.1.0 | ||
| */ | ||
|
|
||
| /** | ||
| * Retrieves the registered knowledge types, keyed by slug. | ||
| * | ||
| * Plugins can register their own types via the {@see 'wp_knowledge_types'} filter. | ||
| * | ||
| * @since 7.1.0 | ||
| * | ||
| * @return array { | ||
| * Slug-keyed map of knowledge types. | ||
| * | ||
| * @type array ...$0 { | ||
| * Data for a single knowledge type. | ||
| * | ||
| * @type string $title The human-readable label for the type. | ||
| * } | ||
| * } | ||
| * @phpstan-return array<non-empty-string, array{title: non-empty-string}> | ||
| */ | ||
| function wp_knowledge_types(): array { | ||
| /** | ||
| * Filters the knowledge types available on this site. | ||
| * | ||
| * @since 7.1.0 | ||
| * | ||
| * @param array $types { | ||
| * Slug-keyed map of knowledge types. | ||
| * | ||
| * @type array ...$0 { | ||
| * Data for a single knowledge type. | ||
| * | ||
| * @type string $title The human-readable label for the type. | ||
| * } | ||
| * } | ||
| * @phpstan-param array<non-empty-string, array{title: non-empty-string}> $types | ||
| */ | ||
| return apply_filters( | ||
| 'wp_knowledge_types', | ||
| array( | ||
| 'guideline' => array( | ||
| 'title' => _x( 'Guideline', 'knowledge type' ), | ||
| ), | ||
| 'memory' => array( | ||
| 'title' => _x( 'Memory', 'knowledge type' ), | ||
| ), | ||
| 'note' => array( | ||
| 'title' => _x( 'Note', 'knowledge type' ), | ||
| ), | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Assigns the `note` fallback term when a knowledge post is saved without a type. | ||
| * | ||
| * Hooked to the `save_post_wp_knowledge` action so that every knowledge row has | ||
| * at least one `wp_knowledge_type` term. Uses get_the_terms() so the check is | ||
| * served by the object term cache. | ||
| * | ||
| * @since 7.1.0 | ||
| * @access private | ||
| * | ||
| * @param int $post_id Saved post ID. | ||
| */ | ||
| function wp_knowledge_ensure_default_type_term( int $post_id ): void { | ||
| if ( wp_is_post_revision( $post_id ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $terms = get_the_terms( $post_id, 'wp_knowledge_type' ); | ||
| if ( is_wp_error( $terms ) || ! empty( $terms ) ) { | ||
| return; | ||
| } | ||
|
|
||
| /* | ||
| * Resolve to a term ID up front, creating the term on first use: | ||
| * wp_set_object_terms() interprets strings as names for hierarchical | ||
| * taxonomies, not slugs. | ||
| */ | ||
| $term = term_exists( 'note', 'wp_knowledge_type' ); | ||
| if ( ! $term ) { | ||
| $term = wp_insert_term( 'note', 'wp_knowledge_type' ); | ||
| if ( is_wp_error( $term ) ) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| wp_set_object_terms( $post_id, (int) $term['term_id'], 'wp_knowledge_type' ); | ||
| } | ||
|
|
||
| /** | ||
| * Swaps a raw knowledge-type slug for its registered label on term creation. | ||
| * | ||
| * Hooked to the `wp_insert_term_data` filter. When wp_set_object_terms() is | ||
| * called with a slug that does not yet exist, wp_insert_term() fires and this | ||
| * filter runs after WordPress has computed both `name` and `slug`. A `name` | ||
| * equal to `slug` indicates the term was created from a raw slug (for example by | ||
| * wp_set_object_terms()) rather than from a user-provided label, so the label is | ||
| * replaced with the title from wp_knowledge_types(). Because term names are | ||
| * persisted in the database, the translated title is stored in the locale active | ||
| * when the term is created. | ||
| * | ||
| * @since 7.1.0 | ||
| * @access private | ||
| * | ||
| * @param array $data Term data to be inserted (keyed by column name). | ||
| * @param string $taxonomy Taxonomy slug. | ||
| * @return array Possibly modified term data. | ||
| * | ||
| * @phpstan-param array<non-empty-string, mixed> $data | ||
| * @phpstan-return array<non-empty-string, mixed> | ||
| */ | ||
| function wp_knowledge_maybe_map_term_label( array $data, string $taxonomy ): array { | ||
| if ( 'wp_knowledge_type' !== $taxonomy ) { | ||
| return $data; | ||
| } | ||
|
|
||
| if ( $data['name'] !== $data['slug'] ) { | ||
| return $data; | ||
| } | ||
|
|
||
| $types = wp_knowledge_types(); | ||
| if ( isset( $types[ $data['slug'] ] ) ) { | ||
| $data['name'] = $types[ $data['slug'] ]['title']; | ||
| } | ||
|
|
||
| return $data; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are not setting delete_with_user, so we use the default and knowledge created by an user is deleted when that user is deleted. I guess that behaviour is correct if the knowledge is private, but it may have unintended consequences for knowledge memory shared between users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I'd lean toward keeping the default (unset) here:
delete_with_user; they're all deleted-or-reassigned on user deletion. Special-casing knowledge would make it the surprising one.So I'd rather not special-case it. Happy to revisit if we later allow non-admins to create shared (non-private) knowledge.