permalinks-customizer

KO | EN

gitlite — search

#javascript #python #hacktoberfest #golang #android #machine-learning #rust #docker #macos #nodejs #awesome-list #security #mcp #ios

permalinks-customizer

(★ 12)

Auto-generate Permalinks for PostTypes, Taxonomies and Attachments as per your desired structure defined in Settings. Permalink can also be changed manually or automatically using Regenerate Permalink button from the edit page. It can also be re-generated using Bulk Action.

permalinks-customizer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Permalinks Customizer

**Permalinks Customizer** helps you to set the different permalink structure for the PostTypes and Taxonomies which are publicly available.

You can use the tags which are defined by the WordPress as mentioned [here](#default-tags-for-posttypes). Also, you can use the tags which are customily defined by this plugin for [PostTypes](#custom-tags-for-posttypes) and [Taxonomies](#custom-tags-for-taxonomies). You can also find these tags in Permalinks Customizer menu on WordPress Dashboard (if the plugin is installed).

## How to set the Permalinks for different PostTypes

Let's assume that you have 7 **PostTypes** and you like to apply different **permalink** structure for them. Like:

| PostType | Desired Permalink | Permalink Settings |
| ---------- | --------------------- | ---------------------- |
| Blog | http://www.example.com/blog/2019/01/02/this-is-a-first-post/ | blog/%year%/%monthnum%/%day%/%postname%/ |
| Customers | http://www.example.com/customers/postname/ | customers/%postname%/ |
| Events | http://www.example.com/events/2019-01-02-wordpress-meetup/ | events/%year%-%monthnum%-%day%-%postname%/ |
| Press | http://www.example.com/press/2019/announce-collaboration/ | press/%year%/%postname%/ |
| News | http://www.example.com/news/2019/this-is-a-news/ | news/%year%/%postname%/ |
| Sponsors | http://www.example.com/company/sponsor/yasglobal/ | company/%title%/ |
| Services | http://www.example.com/services/development/wordpress/ | services/%parent_postname%/ |

This plugin allows you to do this very easily. You just need to go on **Permalinks Customizer** Settings Page. Where text fields are shown with PostType name. You can define your permalinks you want to create for each post type.

If you leave any PostType field empty, **Permalinks Customizer** will create a permalink for that PostType by using the default **permalink** settings.

## How to Configure Permalinks Customizer
You can configure the plugin by navigating to the **Permalinks Customizer** menu from the WordPress Dashboard

## Structure Tags
You can find all the tags which are currently supported by the **Permalinks Customizer**.

### Default Tags for PostTypes
Below mentioned tags are provided by the **WordPress**. These tags can be used on Default **WordPress Permalink** Settings Page as well as **Permalinks Customizer** Settings page.

| Tag Name | Description |
| ----------- | ------------- |
| %year% | The year of the post, four digits, for example 2019 |
| %monthnum% | Month of the year, for example 01 |
| %day% | Day of the month, for example 02 |
| %hour% | Hour of the day, for example 15 |
| %minute% | Minute of the hour, for example 43 |
| %second% | Second of the minute, for example 33 |
| %post_id% | The unique ID of the post, for example 123 |
| %postname% | A sanitized version of the title of the post (post slug field on Edit Post/Page panel). So "This Is A Great Post!" becomes this-is-a-great-post in the URI. |
| %category% | A sanitized version of the category name (category slug field on New/Edit Category panel). Nested sub-categories appear as nested directories in the URI. |
| %author% | A sanitized version of the author name. |

### Custom Tags for PostTypes
Below mentioned tags are provided by the **Permalinks Customizer** for PostTypes. These tags can not be used on the Default **WordPress Permalink** Settings Page.

| Tag Name | Description |
| ----------- | ------------- |
| %title% | Title of the post. let's say the title is "This Is A Great Post!" so, it becomes this-is-a-great-post in the URI. |
| %parent_title% | This tag is similar as `%title%`. Only the difference is that it appends the Immediate **Parent Page Title** in the URI if any parent page is selected. |
| %all_parents_title% | This tag is similar as `%title%`. Only the difference is that it appends all the **Parents Page Title** in the URI if any parent page is selected. |
| %parent_postname% | This tag is similar as `%postname%`. Only the difference is that it appends the Immediate **Parent Page Slug** in the URI if any parent page is selected. |
| %all_parents_postname% | This tag is similar as `%postname%`. Only the difference is that it appends all the **Parents Page Slug** in the URI if any parent page is selected. |
| %child-category% | A sanitized version of the category name (category slug field on New/Edit Category panel). |
| %product_cat% | A sanitized version of the product category name (category slug field on New/Edit Category panel). Nested sub-categories appear as nested directories in the URI. *This `tag` is specially used in WooCommerce Products.* |
| &lt;%ctax_custom_taxonomy%&gt; | A sanitized version of the custom taxonomy where the taxonomy name is `custom_taxonomy`. Replace the `custom_taxonomy` with your appropriate created taxonomy name. If you want to provide the default slug which is used when the category/taxonomy doesn't be selected so, make sure to provide default name/slug which looks like this: `<%ctax_custom_taxonomy??sales%>`. Value which is written between the `??` and `%>` is used as default slug. |
| &lt;%ctaxparents_custom_taxonomy%&gt; | This tag is similar as `<%ctax_custom_taxonomy%>`. Only the difference is that it appends all the **Parents Slug** in the URI if any parent category/tag is selected. |
| %author_firstname% | A sanitized version of the author first name. If author first name is not available then it uses the author's username. |
| %author_lastname% | A sanitized version of the author last name. If author last name is not available then it uses the author's username. |
| %pc_custom_posttype_tag% | Permits a theme or plugin developer define the tag value using a [filter](#set-custom-value-in-posttype-permalink) |

**Note**: `%title%` is similar as `%postname%` tag but the difference is that `%postname%` can only be set once by WordPress whereas `%title%` can be changed by user at multiple times. let's say the title is "This Is A Great Post!" so, it becomes "this-is-a-great-post" in the URI(At the first time, `%postname%` and `%title%` works same) but if you edit and change title let's say "This Is A WordPress Post!" so, `%postname%` in the URI remains same "this-is-a-great-post" whereas `%title%` in the URI becomes "this-is-a-wordpress-post".

### Custom Tags for Taxonomies
Below mentioned tags are provided by the **Permalinks Customizer** for Taxonomies. These can not be used on the Default **WordPress Permalink** Settings Page.

| Tag Name | Description |
| ----------- | ------------- |
| %name% | Name of the Term/Category. let's say the name is "External API" so, it becomes external-api in the URI. |
| %term_id% | The unique ID # of the Term/Category, for example 423 |
| %slug% | A sanitized version of the name of the Term/Category. So "External API" becomes external-api in the URI. |
| %parent_slug% | This tag is similar as `%slug%`. Only the difference is that it appends the immediate **Parent Term/Category Slug** in the URI if any parent Term/Category is selected. |
| %all_parents_slug% | This tag is similar as `%slug%`. Only the difference is that it appends all the **Parent Terms/Category Slugs** in the URI if any parent Term/Category is selected. |
| %pc_custom_taxonomy_tag% | Permits a theme or plugin developer define the tag value using a [filter](#set-custom-value-in-taxonomy-permalink) |

## Filters
You can find all the filters below which are provided by **Permalinks Customizer** plugin. These filters can be used as per your Website requirement.

### Set Custom value in PostType Permalink

This filter allow to replace the custom tag with your desired value. It can be any custom field value or anything else. 
```
/**
 * set the text which replace the custom tag from the permalink.
 *
 * @since 2.8.0
 *
 * @param object $post The post object.
 *
 * @return string text which can be replaced with the custom tag.
 */
function yasglobal_custom_posttype_tag( $post ) {
  return sanitize_title( $post->post_title ) . '-from-sami';
}
add_filter( 'pc_custom_posttype_tag', 'yasglobal_custom_posttype_tag', 10, 1 );
```

### Set Custom value in Taxonomy Permalink

This filter allow to replace the custom tag with your desired value. It can be any custom field value or anything else. 
```
/**
 * set the text which replace the custom tag from the permalink.
 *
 * @since 2.8.2
 *
 * @param object $term The term object.
 *
 * @return string text which can be replaced with the custom tag.
 */
function yasglobal_custom_taxonomy_tag( $term ) {
  return sanitize_title( $term->name ) . '-from-sami';
}
add_filter( 'pc_custom_taxonomy_tag', 'yasglobal_custom_taxonomy_tag', 10, 1 );
```

### Exclude Permalinks

If you want to exclude some Permalink to processed with the plugin so, just add the filter looks like this:
```
function yasglobal_exclude_url( $permalink ) {
  if ( false !== strpos( $permalink, '/contact-us/' ) ) {
    return '__true';
  }
  return;
}
add_filter( 'permalinks_customizer_exclude_request', 'yasglobal_exclude_url' );
```

### Show Relative Permalink/URL

To show relative permalink/url in Edit Post, add this filter in your themes functions.php.
```
add_filter( 'permalinks_customizer_remove_home_url', '__return_true' );
```

### Exclude PostType from the Plugin

To exclude the plugin to be worked on any PostType. Add this filter in your themes functions.php.

```
function yasglobal_exclude_post_types( $post_type ) {
  if ( $post_type == 'page' ) {
    return '__true';
  }
  return '__false';
}
add_filter( 'permalinks_customizer_exclude_post_type', 'yasglobal_exclude_post_types');
```
**Note**: Plugin stops working on the backend. *No more permalinks* would be generated by the plugin but the permalink which are already created will remains in work.

### Disable automatically create redirects

To disable automatically create redirects feature on creating and updating the post/pages/categories, add this filter in your themes functions.php.
```
add_filter( 'permalinks_customizer_auto_created_redirects', '__return_false');
```
This filter stops to be creating new redirects but existed redirects keeps working. To stop existed redirects, add [this](#disable-redirects) filter.

### Disable Redirects

To disable redirects to be applied , add this filter in your themes functions.php.
```
add_filter( 'permalinks_customizer_disable_redirects', '__return_false');
```
This filter only stop redirects to be work but the automatically create redirects still works. To stop automatically create redirects feature add [this](#disable-automatically-create-redirects) filter.

## Installation

This process defines you the steps to follow either you are installing through WordPress or Manually from FTP.

### From within WordPress

1. Visit 'Plugins > Add New'
2. Search for Permalinks Customizer
3. Activate Permalinks Customizer from your Plugins page.
4. Go to [after activation](#after-activation) below.

### Manually

1. Upload the `permalinks-customizer` folder to the `/wp-content/plugins/` directory
2. Activate Permalinks Customizer through the 'Plugins' menu in WordPress
3. Go to [after activation](#after-activation) below.

### After activation

1. Go to the plugin settings page and set up the plugin for your site.
2. You're done!

## Frequently Asked Questions

**Q. How to define Settings for the PostType?**

A. Navigate on **Permalinks Customizer** Menu from the **WordPress Dashboard**, Open PostTypes Settings Page, there is a textfield for each and every PostType (if the PostType is available for **Public**) . On this field, you can define structure which is used for that PostType.

**Q. Can i use tags in PostType Settings?**

A. Yes, you can use any tag which are defined in [Default Tags for PostTypes](#default-tags-for-posttypes) and [Custom Tags for Taxonomies](#custom-tags-for-taxonomies).

**Q. Does the plugin supports custom taxonomy tag?**

A. Yes, it supports the custom taxonomy tag as defined [here](#custom-tags-for-posttypes).

**Q. Can i see the created permalinks for the PostType?**

A. Yes, you can see all the created permalinks on the PostType Permalinks Page under Permalinks Customizer.

**Q. How to define Settings for the Taxonomies?**

A. Navigate on **Permalinks Customizer** Menu from the **WordPress Dashboard**, Open Taxonomies Settings Page, there is a textfield for each and every Taxonomy (if the Taxonomy is available for **Public**) . On this field, you can define structure which is used for that Taxonomy.

**Q. Can i use tags in Taxonomies Settings?**

A. Yes, you can use any tag which are defined [here](#custom-tags-for-taxonomies).

**Q. Can i see the created permalinks for the Taxonomies?**

A. Yes, you can see all the created permalinks on the Taxonomies Permalinks Page under Permalinks Customizer.

**Q. Can i regenerate all the permalinks according to the defined structure?**

A. Yes, you can regenerate all the permalinks according to the defined structure. To have a bulk permalink update, Go to the *All Post* page there is an option in the bulk action drop down with the name of `Regenerate Permalinks`. Use that option for regenerating the Permalinks.

**Q. Does *Regenerate Permalinks* damage my site SEO?**

A. No, it won't damage your site SEO. As regenerating permalinks added redirect against their previous permalink.

**Q. Can i see the available redirects?**

A. Yes, you can see the all the redirects created by this plugin from the Redirects Page under the Permalinks Customizer in the WordPress Dashboard.

**Q. Can i disable/delete redirects?**

A. Yes, you can disable/delete the redirects from the Redirects Page using Bulk Action.

**Q. Can i exclude PostType from the Plugin?**

A. Yes, you can exclude any posttype from the plugin to be worked on. For this just add the filter as shown [here](#exclude-posttype-from-the-plugin).

permalinks-customizer

permalinks-customizer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

permalinks-customizer

permalinks-customizer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README