Skip to content
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

Changes the way we decide which content types are displayed in the settings. #19603

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Jan 10, 2023

Context

  • We only want to show content types that are actually being indexed to show up in the settings.
    I added the same check for both taxonomies and custom post types because in both cases we sometimes don't create indexable. For example if they are not set public or excluded via one of our filters. I these cases we also do not want to display them in the menu sidebar because it does not make sense to optimise a page that is not indexed in the first place.
    The check implemented is exactly the same as the check used to determine if a cpt or tax should be an indexable.

Summary

This PR can be summarized in the following changelog entry:

  • Updates the content types to only show indexable ones.

Relevant technical choices:

  • Added a new function to more cleanly get objects instead of adding a parameter and doing an if check.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Make sure elementor is enabled.

  • Without this PR you should see a my templates content type in https://wordpress.test/wp-admin/admin.php?page=wpseo_page_settings#/site-features

  • Checkout this PR. The My templates should be gone.

  • Make sure all your public post types are still there.

  • add a public taxonomy with a plugin like custom cpt and make sure it shows up in the Categories & tags section.

  • Make the taxonomy non public and make sure it is no longer there.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Block/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change.

Quality assurance

  • I have tested this code to the best of my abilities
  • I have added unit tests to verify the code works as intended
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Fixes #

@thijsoo thijsoo added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jan 10, 2023
@thijsoo thijsoo added this to the 20.0 milestone Jan 10, 2023
@thijsoo thijsoo force-pushed the 19552-elementor_library-post-type-can-be-removed-from-settings-content-types branch from 15e5036 to f88ee34 Compare January 10, 2023 14:06
Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR && AC ✅

Only you forgot the \ prefixes for the global namespace functions. I'll commit those from the comments and merge!

src/helpers/post-type-helper.php Outdated Show resolved Hide resolved
src/helpers/taxonomy-helper.php Outdated Show resolved Hide resolved
@igorschoester igorschoester merged commit 71db0fb into release/20.0 Jan 11, 2023
@igorschoester igorschoester deleted the 19552-elementor_library-post-type-can-be-removed-from-settings-content-types branch January 11, 2023 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

elementor_library post type can be removed from Settings > Content Types
2 participants